Public Member Functions | |
| __construct (array $results, array $interwikiResults=[]) | |
| extractResults () | |
| Extract all the results in the result set as array. | |
| getInterwikiResults ( $type=self::SECONDARY_RESULTS) | |
| Return a result set of hits on other (multiple) wikis associated with this one. | |
| hasInterwikiResults ( $type=self::SECONDARY_RESULTS) | |
| Check if there are results on other wikis. | |
| numRows () | |
 Public Member Functions inherited from SearchResultSet | |
| __construct ( $containedSyntax=false, $hasMoreResults=false) | |
| augmentResult (SearchResult $result) | |
| Returns extra data for specific result and store it in SearchResult object. | |
| count () | |
| extractTitles () | |
| Extract all the titles in the result set. | |
| free () | |
| Frees the result set, if applicable. | |
| getIterator () | |
| getOffset () | |
| getQueryAfterRewrite () | |
| getQueryAfterRewriteSnippet () | |
| getSuggestionQuery () | |
| getSuggestionSnippet () | |
| getTotalHits () | |
| Some search modes return a total hit count for the query in the entire article database. | |
| 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. | |
| next () | |
| Fetches next search result, or false. | |
| rewind () | |
| Rewind result set back to beginning. | |
| 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) | |
| termMatches () | |
| Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. | |
Private Attributes | |
| $interwikiResults | |
Additional Inherited Members | |
| Protected Attributes inherited from SearchResultSet | |
| $containedSyntax = false | |
| Types of interwiki results. | |
| array[] | $extraData = [] |
| Set of result's extra data, indexed per result id and then per data item name. | |
| SearchResult[] | $results |
| Cache of results - serialization of the result iterator as an array. | |
Detailed Description
Definition at line 3 of file MockSearchResultSet.php.
Constructor & Destructor Documentation
◆ __construct()
- Parameters
-
SearchResult[] | callable[] $results SearchResultSet[][] | callable[][] $interwikiResults Map from result type to list of results for that type.
Definition at line 15 of file MockSearchResultSet.php.
References $interwikiResults, and SearchResultSet\$results.
Member Function Documentation
◆ extractResults()
| MockSearchResultSet::extractResults | ( | ) |
Extract all the results in the result set as array.
- Returns
- SearchResult[]
Reimplemented from SearchResultSet.
Definition at line 30 of file MockSearchResultSet.php.
References SearchResultSet\$results, and as.
◆ getInterwikiResults()
| MockSearchResultSet::getInterwikiResults | ( | $type = self::SECONDARY_RESULTS | ) |
Return a result set of hits on other (multiple) wikis associated with this one.
- Parameters
-
int $type
- Returns
- SearchResultSet[]
Reimplemented from SearchResultSet.
Definition at line 43 of file MockSearchResultSet.php.
References $type, and hasInterwikiResults().
◆ hasInterwikiResults()
| MockSearchResultSet::hasInterwikiResults | ( | $type = self::SECONDARY_RESULTS | ) |
Check if there are results on other wikis.
- Parameters
-
int $type
- Returns
- bool
Reimplemented from SearchResultSet.
Definition at line 25 of file MockSearchResultSet.php.
References $type, and SearchResultSet\count().
Referenced by getInterwikiResults().
◆ numRows()
| MockSearchResultSet::numRows | ( | ) |
Reimplemented from SearchResultSet.
Definition at line 21 of file MockSearchResultSet.php.
References SearchResultSet\count().
Member Data Documentation
◆ $interwikiResults
|
private |
Definition at line 8 of file MockSearchResultSet.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- tests/phpunit/mocks/search/MockSearchResultSet.php
