MediaWiki master
|
BaseSearchResultSet is the base class that must be extended by SearchEngine search result set implementations. More...
Inherits ISearchResultSet.
Inherited by SearchResultSet.
Public Member Functions | |
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. | |
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. | |
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) | |
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. | |
BaseSearchResultSet is the base class that must be extended by SearchEngine search result set implementations.
This base class is meant to hold B/C behaviors and to be useful it must never:
Definition at line 15 of file BaseSearchResultSet.php.
BaseSearchResultSet::free | ( | ) |
Frees the result set, if applicable.
Definition at line 84 of file BaseSearchResultSet.php.
BaseSearchResultSet::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.
Implements ISearchResultSet.
Definition at line 64 of file BaseSearchResultSet.php.
BaseSearchResultSet::next | ( | ) |
Fetches next search result, or false.
Definition at line 27 of file BaseSearchResultSet.php.
References wfDeprecated().
BaseSearchResultSet::rewind | ( | ) |
Rewind result set back to beginning.
Definition at line 39 of file BaseSearchResultSet.php.
References wfDeprecated().
BaseSearchResultSet::termMatches | ( | ) |
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.
STUB
Reimplemented in SqlSearchResultSet.
Definition at line 76 of file BaseSearchResultSet.php.