This class is used for different SQL-based search engines shipped with MediaWiki. More...

Inherits MediaWiki\Search\SearchResultSet.

Collaboration diagram for MediaWiki\Search\SqlSearchResultSet:

[legend]

Public Member Functions
	__construct (IResultWrapper $resultSet, array $terms, $total=null)

	extractResults ()
	Extract all the results in the result set as array. Returns SearchResult[]

	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

	numRows ()
	Returns int

	termMatches ()

Public Member Functions inherited from MediaWiki\Search\SearchResultSet
	__construct ( $containedSyntax=false, $hasMoreResults=false)

	count ()

	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 ()

	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.

	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.

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
IResultWrapper	$resultSet
	@noinspection PhpMissingParentConstructorInspection

string[]	$terms
	Requested search query.

int null	$totalHits
	Total number of hits for $terms.

Protected Attributes inherited from MediaWiki\Search\SearchResultSet
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

This class is used for different SQL-based search engines shipped with MediaWiki.

Definition at line 13 of file SqlSearchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SqlSearchResultSet::__construct	(	IResultWrapper	$resultSet,
		array	$terms,
			$total = null )

Parameters

IResultWrapper	$resultSet
string[]	$terms
int \| null	$total

Definition at line 28 of file SqlSearchResultSet.php.

References MediaWiki\Search\SqlSearchResultSet\$resultSet, and MediaWiki\Search\SqlSearchResultSet\$terms.

Member Function Documentation

◆ extractResults()

MediaWiki\Search\SqlSearchResultSet::extractResults ( )

Extract all the results in the result set as array.

Returns: SearchResult[]

Reimplemented from MediaWiki\Search\SearchResultSet.

Definition at line 53 of file SqlSearchResultSet.php.

References MediaWiki\Search\SearchResultSet\$results, MediaWiki\Search\SqlSearchResultSet\$terms, MediaWiki\Search\augmentResult(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\makeTitle().

◆ getTotalHits()

MediaWiki\Search\SqlSearchResultSet::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.