Inherits MediaWiki\Search\BaseSearchResultSet.

Inherited by MediaWiki\Search\FauxSearchResultSet, MediaWiki\Search\SearchNearMatchResultSet, and MediaWiki\Search\SqlSearchResultSet.

Collaboration diagram for MediaWiki\Search\SearchResultSet:

[legend]

Public Member Functions
	__construct ( $containedSyntax=false, $hasMoreResults=false)

	count ()

	extractResults ()
	Extract all the results in the result set as array.

	extractTitles ()
	Extract all the titles in the result set.

	getInterwikiResults ( $type=self::SECONDARY_RESULTS)
	Return a result set of hits on other (multiple) wikis associated with this one.

	getQueryAfterRewrite ()

	getQueryAfterRewriteSnippet ()

	getSuggestionQuery ()

	getSuggestionSnippet ()

	getTotalHits ()
	Some search modes return a total hit count for the query in the entire article database.

	hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
	Check if there are results on other wikis.

	hasMoreResults ()

	hasRewrittenQuery ()
	Some search modes will run an alternative query that it thinks gives a better result than the provided search.

	hasSuggestion ()
	Some search modes return a suggested alternate term if there are no exact hits.

	numRows ()
	Returns int

	searchContainedSyntax ()
	Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a page named by the search string because the name would contain the search syntax.

	shrink ( $limit)

Public Member Functions inherited from MediaWiki\Search\BaseSearchResultSet
	free ()
	Frees the result set, if applicable.

	isApproximateTotalHits ()
	If `getTotalHits()` is supported determine whether this number is approximate or not.Some engine might perform optimizations that might lead to inaccurate total hits. If this happens such engine should return true. Returns bool Since 1.44

	next ()
	Fetches next search result, or false.

	rewind ()
	Rewind result set back to beginning.

	termMatches ()
	Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.

Public Member Functions inherited from MediaWiki\Search\ISearchResultSet
	augmentResult (SearchResult $result)
	Returns extra data for specific result and store it in SearchResult object.

	getOffset ()

	setAugmentedData ( $name, $data)
	Sets augmented data for result set.

Protected Attributes
bool	$containedSyntax = false

SearchResult[]	$results
	Cache of results - serialization of the result iterator as an array.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Search\ISearchResultSet
const	INLINE_RESULTS = 1
	Identifier for interwiki results that can be displayed even if no existing main wiki results exist.

const	SECONDARY_RESULTS = 0
	Identifier for interwiki results that are displayed only together with existing main wiki results.

Detailed Description

Definition at line 18 of file SearchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SearchResultSet::__construct	(		$containedSyntax = false,
			$hasMoreResults = false )

Parameters

bool	$containedSyntax	True when query is not requesting a simple term match
bool	$hasMoreResults	True when there are more pages of search results available.

Definition at line 50 of file SearchResultSet.php.

References MediaWiki\Search\SearchResultSet\$containedSyntax, MediaWiki\Search\SearchResultSet\hasMoreResults(), and wfDeprecated().

Member Function Documentation

◆ count()

MediaWiki\Search\SearchResultSet::count ( )

final

Definition at line 66 of file SearchResultSet.php.

Referenced by MediaWiki\Search\FauxSearchResultSet\__construct(), and MediaWiki\Search\SearchResultSet\numRows().

◆ extractResults()

MediaWiki\Search\SearchResultSet::extractResults ( )

Extract all the results in the result set as array.

Returns: SearchResult[]

Implements MediaWiki\Search\ISearchResultSet.

Reimplemented in MediaWiki\Search\SqlSearchResultSet.

Definition at line 199 of file SearchResultSet.php.

◆ extractTitles()

MediaWiki\Search\SearchResultSet::extractTitles ( )

Extract all the titles in the result set.

Returns: Title[]

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 219 of file SearchResultSet.php.

References MediaWiki\Search\SearchResult\getTitle().

◆ getInterwikiResults()

MediaWiki\Search\SearchResultSet::getInterwikiResults ( $type = self::SECONDARY_RESULTS )

Return a result set of hits on other (multiple) wikis associated with this one.

Parameters

int $type

Returns: ISearchResultSet[]|null

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 142 of file SearchResultSet.php.

◆ getQueryAfterRewrite()

MediaWiki\Search\SearchResultSet::getQueryAfterRewrite ( )

Returns: string|null The search the query was internally rewritten to, or null when the result of the original query was returned.

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 99 of file SearchResultSet.php.

◆ getQueryAfterRewriteSnippet()

MediaWiki\Search\SearchResultSet::getQueryAfterRewriteSnippet ( )

Returns: HtmlArmor|string|null Same as self::getQueryAfterRewrite(), but with changes highlighted if HtmlArmor is returned. Null when the query was not rewritten.

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 108 of file SearchResultSet.php.

◆ getSuggestionQuery()

MediaWiki\Search\SearchResultSet::getSuggestionQuery ( )

Returns: string|null Suggested query, null if none

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 125 of file SearchResultSet.php.

◆ getSuggestionSnippet()

MediaWiki\Search\SearchResultSet::getSuggestionSnippet ( )

Returns: HtmlArmor|string HTML highlighted suggested query, '' if none

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 132 of file SearchResultSet.php.

◆ getTotalHits()

MediaWiki\Search\SearchResultSet::getTotalHits ( )

Some search modes return a total hit count for the query in the entire article database.

This may include pages in namespaces that would not be matched on the given settings.

Return null if no total hits number is supported.

Returns: int|null

Implements MediaWiki\Search\ISearchResultSet.

Reimplemented in MediaWiki\Search\FauxSearchResultSet, and MediaWiki\Search\SqlSearchResultSet.

Definition at line 80 of file SearchResultSet.php.

◆ hasInterwikiResults()

MediaWiki\Search\SearchResultSet::hasInterwikiResults ( $type = self::SECONDARY_RESULTS )

Check if there are results on other wikis.

Parameters

int $type

Returns: bool

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 152 of file SearchResultSet.php.

◆ hasMoreResults()

MediaWiki\Search\SearchResultSet::hasMoreResults ( )

Returns: bool True when there are more pages of search results available.

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 169 of file SearchResultSet.php.

Referenced by MediaWiki\Search\SearchResultSet\__construct().

◆ hasRewrittenQuery()

MediaWiki\Search\SearchResultSet::hasRewrittenQuery ( )

Some search modes will run an alternative query that it thinks gives a better result than the provided search.

Returns true if this has occurred.

Returns: bool

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 91 of file SearchResultSet.php.

◆ hasSuggestion()

MediaWiki\Search\SearchResultSet::hasSuggestion ( )

Some search modes return a suggested alternate term if there are no exact hits.

Returns true if there is one on this set.

Returns: bool

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 118 of file SearchResultSet.php.

◆ numRows()

MediaWiki\Search\SearchResultSet::numRows ( )

Returns: int

Implements MediaWiki\Search\ISearchResultSet.

Reimplemented in MediaWiki\Search\SearchNearMatchResultSet, and MediaWiki\Search\SqlSearchResultSet.

Definition at line 62 of file SearchResultSet.php.

References MediaWiki\Search\SearchResultSet\count().

◆ searchContainedSyntax()

MediaWiki\Search\SearchResultSet::searchContainedSyntax ( )

Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a page named by the search string because the name would contain the search syntax.

Returns: bool

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 162 of file SearchResultSet.php.

◆ shrink()

MediaWiki\Search\SearchResultSet::shrink ( $limit )

Parameters

int $limit Shrink result set to $limit and flag if more results are available.

Implements MediaWiki\Search\ISearchResultSet.

Definition at line 177 of file SearchResultSet.php.

Member Data Documentation

◆ $containedSyntax

bool MediaWiki\Search\SearchResultSet::$containedSyntax = false

protected

Definition at line 23 of file SearchResultSet.php.

Referenced by MediaWiki\Search\SearchResultSet\__construct().

◆ $results

SearchResult [] MediaWiki\Search\SearchResultSet::$results

protected

Cache of results - serialization of the result iterator as an array.

Definition at line 37 of file SearchResultSet.php.

Referenced by MediaWiki\Search\FauxSearchResultSet\__construct(), and MediaWiki\Search\SqlSearchResultSet\extractResults().

The documentation for this class was generated from the following file:

includes/Search/SearchResultSet.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ count()

◆ extractResults()

◆ extractTitles()

◆ getInterwikiResults()

◆ getQueryAfterRewrite()

◆ getQueryAfterRewriteSnippet()

◆ getSuggestionQuery()

◆ getSuggestionSnippet()

◆ getTotalHits()

◆ hasInterwikiResults()

◆ hasMoreResults()

◆ hasRewrittenQuery()

◆ hasSuggestion()

◆ numRows()

◆ searchContainedSyntax()

◆ shrink()

Member Data Documentation

◆ $containedSyntax

◆ $results