MediaWiki master
|
Inherits BaseSearchResultSet.
Inherited by FauxSearchResultSet, SearchNearMatchResultSet, and SqlSearchResultSet.
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 () | |
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) | |
![]() | |
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. | |
![]() | |
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 | |
![]() | |
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. | |
Definition at line 30 of file SearchResultSet.php.
SearchResultSet::__construct | ( | $containedSyntax = false, | |
$hasMoreResults = false ) |
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 62 of file SearchResultSet.php.
References $containedSyntax, hasMoreResults(), and wfDeprecated().
|
final |
Definition at line 77 of file SearchResultSet.php.
Referenced by FauxSearchResultSet\__construct(), and numRows().
SearchResultSet::extractResults | ( | ) |
Extract all the results in the result set as array.
Implements ISearchResultSet.
Reimplemented in SqlSearchResultSet.
Definition at line 210 of file SearchResultSet.php.
SearchResultSet::extractTitles | ( | ) |
Extract all the titles in the result set.
Implements ISearchResultSet.
Definition at line 230 of file SearchResultSet.php.
SearchResultSet::getInterwikiResults | ( | $type = self::SECONDARY_RESULTS | ) |
Return a result set of hits on other (multiple) wikis associated with this one.
int | $type |
Implements ISearchResultSet.
Definition at line 153 of file SearchResultSet.php.
SearchResultSet::getQueryAfterRewrite | ( | ) |
Implements ISearchResultSet.
Definition at line 110 of file SearchResultSet.php.
SearchResultSet::getQueryAfterRewriteSnippet | ( | ) |
Implements ISearchResultSet.
Definition at line 119 of file SearchResultSet.php.
SearchResultSet::getSuggestionQuery | ( | ) |
Implements ISearchResultSet.
Definition at line 136 of file SearchResultSet.php.
SearchResultSet::getSuggestionSnippet | ( | ) |
Implements ISearchResultSet.
Definition at line 143 of file SearchResultSet.php.
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.
Implements ISearchResultSet.
Reimplemented in FauxSearchResultSet, and SqlSearchResultSet.
Definition at line 91 of file SearchResultSet.php.
SearchResultSet::hasInterwikiResults | ( | $type = self::SECONDARY_RESULTS | ) |
Check if there are results on other wikis.
int | $type |
Implements ISearchResultSet.
Definition at line 163 of file SearchResultSet.php.
SearchResultSet::hasMoreResults | ( | ) |
Implements ISearchResultSet.
Definition at line 180 of file SearchResultSet.php.
Referenced by __construct().
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.
Implements ISearchResultSet.
Definition at line 102 of file SearchResultSet.php.
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.
Implements ISearchResultSet.
Definition at line 129 of file SearchResultSet.php.
SearchResultSet::numRows | ( | ) |
Implements ISearchResultSet.
Reimplemented in SearchNearMatchResultSet, and SqlSearchResultSet.
Definition at line 73 of file SearchResultSet.php.
References count().
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.
Implements ISearchResultSet.
Definition at line 173 of file SearchResultSet.php.
SearchResultSet::shrink | ( | $limit | ) |
int | $limit | Shrink result set to $limit and flag if more results are available. |
Implements ISearchResultSet.
Definition at line 188 of file SearchResultSet.php.
|
protected |
Definition at line 35 of file SearchResultSet.php.
Referenced by __construct().
|
protected |
Cache of results - serialization of the result iterator as an array.
Definition at line 49 of file SearchResultSet.php.
Referenced by FauxSearchResultSet\__construct(), and SqlSearchResultSet\extractResults().