MediaWiki\Search\FauxSearchResultSet Class Reference
A manually constructed search result set. More...
Inherits MediaWiki\Search\SearchResultSet.
Collaboration diagram for MediaWiki\Search\FauxSearchResultSet:
Public Member Functions | |
| __construct (array $results, $totalHits=null) | |
| 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.
| |
 Public Member Functions inherited from MediaWiki\Search\SearchResultSet | |
| __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 () | |
| 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 () | |
| |
| 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.
| |
| 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. | |
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. | |
| Protected Attributes inherited from MediaWiki\Search\SearchResultSet | |
| bool | $containedSyntax = false |
| SearchResult[] | $results |
| Cache of results - serialization of the result iterator as an array. | |
Detailed Description
A manually constructed search result set.
Mainly meant for supporting developer setups where the search operation might be mocked or proxied.
Definition at line 13 of file FauxSearchResultSet.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Search\FauxSearchResultSet::__construct | ( | array | $results, |
| $totalHits = null ) |
- Parameters
-
array<Title|SearchResult> $results Search results int | null $totalHits See getTotalHits()
Definition at line 25 of file FauxSearchResultSet.php.
References MediaWiki\Search\SearchResultSet\$results, and MediaWiki\Search\SearchResultSet\count().
Member Function Documentation
◆ getTotalHits()
| MediaWiki\Search\FauxSearchResultSet::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
Reimplemented from MediaWiki\Search\SearchResultSet.
Definition at line 42 of file FauxSearchResultSet.php.
The documentation for this class was generated from the following file:
- includes/Search/FauxSearchResultSet.php
