A set of SearchEngine results. More...

Inherits Countable, and IteratorAggregate.

Inherited by MediaWiki\Search\BaseSearchResultSet.

Collaboration diagram for MediaWiki\Search\ISearchResultSet:

[legend]

Public Member Functions
	augmentResult (SearchResult $result)
	Returns extra data for specific result and store it in SearchResult object.

	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.

	getOffset ()

	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.

	isApproximateTotalHits ()
	If `getTotalHits()` is supported determine whether this number is approximate or not.

	numRows ()

	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.

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

	shrink ( $limit)

Public Attributes
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

A set of SearchEngine results.

Must not be implemented directly by extensions, extend BaseSearchResultSet instead.

Stability: stable: to type

See also: BaseSearchResultSet

Definition at line 17 of file ISearchResultSet.php.

Member Function Documentation

◆ augmentResult()

MediaWiki\Search\ISearchResultSet::augmentResult ( SearchResult $result )

Returns extra data for specific result and store it in SearchResult object.

◆ extractResults()

MediaWiki\Search\ISearchResultSet::extractResults ( )

Extract all the results in the result set as array.

Returns: SearchResult[]

Implemented in MediaWiki\Search\SearchResultSet, and MediaWiki\Search\SqlSearchResultSet.

Referenced by MediaWiki\Search\PerRowAugmentor\augmentAll().

◆ extractTitles()

MediaWiki\Search\ISearchResultSet::extractTitles ( )

Extract all the titles in the result set.

Returns: Title[]

Implemented in MediaWiki\Search\SearchResultSet.

◆ getInterwikiResults()

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

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

Parameters

int $type

Returns: ISearchResultSet[]

Implemented in MediaWiki\Search\SearchResultSet.

◆ getOffset()

MediaWiki\Search\ISearchResultSet::getOffset ( )

Returns: int|null The offset the current page starts at. Typically this should be null to allow the UI to decide on its own, but in special cases like interleaved AB tests specifying explicitly is necessary.

◆ getQueryAfterRewrite()

MediaWiki\Search\ISearchResultSet::getQueryAfterRewrite ( )

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

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\rewrittenHtml().

◆ getQueryAfterRewriteSnippet()

MediaWiki\Search\ISearchResultSet::getQueryAfterRewriteSnippet ( )

Returns: HtmlArmor|string|null Same as self::getQueryAfterRewrite(), but with changes to the string highlighted in HTML and wrapped in HtmlArmor. If highlighting is not available the rewritten query will be returned. When the self::hasRewrittenQuery returns false (i.e. the results have not been rewritten) null will be returned.

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\rewrittenHtml().

◆ getSuggestionQuery()

MediaWiki\Search\ISearchResultSet::getSuggestionQuery ( )

Returns: string|null Suggested query, null if none

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\suggestionHtml().

◆ getSuggestionSnippet()

MediaWiki\Search\ISearchResultSet::getSuggestionSnippet ( )

Returns: HtmlArmor|string Same as self::getSuggestionQuery(), but with changes to the string highlighted in HTML and wrapped in HtmlArmor. If highlighting is not available the suggested query will be returned. When self::hasSuggestion returns false (i.e no suggested query) the empty string will be returned.

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\suggestionHtml().

◆ getTotalHits()

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

Implemented in MediaWiki\Search\FauxSearchResultSet, MediaWiki\Search\SearchResultSet, and MediaWiki\Search\SqlSearchResultSet.

◆ hasInterwikiResults()

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

Check if there are results on other wikis.

Parameters

int $type

Returns: bool

Implemented in MediaWiki\Search\SearchResultSet.

◆ hasMoreResults()

MediaWiki\Search\ISearchResultSet::hasMoreResults ( )

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

Implemented in MediaWiki\Search\SearchResultSet.

◆ hasRewrittenQuery()

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

NOTE: In practice this has only been applied when the original query returned no results. UI messages, such as search-rewritten, have this assumption baked in.

Returns: bool

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\render().

◆ hasSuggestion()

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

Implemented in MediaWiki\Search\SearchResultSet.

Referenced by MediaWiki\Search\SearchWidgets\DidYouMeanWidget\render().

◆ isApproximateTotalHits()

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

Implemented in MediaWiki\Search\BaseSearchResultSet.

◆ numRows()

MediaWiki\Search\ISearchResultSet::numRows ( )

Returns: int

Implemented in MediaWiki\Search\SearchNearMatchResultSet, MediaWiki\Search\SearchResultSet, and MediaWiki\Search\SqlSearchResultSet.

◆ searchContainedSyntax()

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

Implemented in MediaWiki\Search\SearchResultSet.

◆ setAugmentedData()

MediaWiki\Search\ISearchResultSet::setAugmentedData	(		$name,
			$data )

Sets augmented data for result set.

Parameters

string	$name	Extra data item name
array[]	$data	Extra data as PAGEID => data

Referenced by MediaWiki\Search\SearchEngine\augmentSearchResults().

◆ shrink()

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

Parameters

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

Implemented in MediaWiki\Search\SearchResultSet.

Member Data Documentation

◆ INLINE_RESULTS

const MediaWiki\Search\ISearchResultSet::INLINE_RESULTS = 1

Identifier for interwiki results that can be displayed even if no existing main wiki results exist.

Definition at line 28 of file ISearchResultSet.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\render().

◆ SECONDARY_RESULTS

const MediaWiki\Search\ISearchResultSet::SECONDARY_RESULTS = 0

Identifier for interwiki results that are displayed only together with existing main wiki results.

Definition at line 22 of file ISearchResultSet.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\render().

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

includes/Search/ISearchResultSet.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ augmentResult()

◆ extractResults()

◆ extractTitles()

◆ getInterwikiResults()

◆ getOffset()

◆ getQueryAfterRewrite()

◆ getQueryAfterRewriteSnippet()

◆ getSuggestionQuery()

◆ getSuggestionSnippet()

◆ getTotalHits()

◆ hasInterwikiResults()

◆ hasMoreResults()

◆ hasRewrittenQuery()

◆ hasSuggestion()

◆ isApproximateTotalHits()

◆ numRows()

◆ searchContainedSyntax()

◆ setAugmentedData()

◆ shrink()

Member Data Documentation

◆ INLINE_RESULTS

◆ SECONDARY_RESULTS