This class is used for different SQL-based search engines shipped with MediaWiki. More...
Public Member Functions | |
| __construct (ResultWrapper $resultSet, $terms, $total=null) | |
| free () | |
| getTotalHits () | |
| next () | |
| numRows () | |
| rewind () | |
| termMatches () | |
 Public Member Functions inherited from SearchResultSet | |
| __construct ($containedSyntax=false) | |
| augmentResult (SearchResult $result) | |
| Returns extra data for specific result and store it in SearchResult object. More... | |
| extractResults () | |
| Extract all the results in the result set as array. More... | |
| extractTitles () | |
| Extract all the titles in the result set. More... | |
| free () | |
| Frees the result set, if applicable. More... | |
| getInterwikiResults ($type=self::SECONDARY_RESULTS) | |
| Return a result set of hits on other (multiple) wikis associated with this one. More... | |
| getQueryAfterRewrite () | |
| getQueryAfterRewriteSnippet () | |
| getSuggestionQuery () | |
| getSuggestionSnippet () | |
| getTotalHits () | |
| Some search modes return a total hit count for the query in the entire article database. More... | |
| hasInterwikiResults ($type=self::SECONDARY_RESULTS) | |
| Check if there are results on other wikis. More... | |
| hasRewrittenQuery () | |
| Some search modes will run an alternative query that it thinks gives a better result than the provided search. More... | |
| hasSuggestion () | |
| Some search modes return a suggested alternate term if there are no exact hits. More... | |
| next () | |
| Fetches next search result, or false. More... | |
| numRows () | |
| rewind () | |
| Rewind result set back to beginning. More... | |
| 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. More... | |
| setAugmentedData ($name, $data) | |
| Sets augmented data for result set. More... | |
| termMatches () | |
| Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. More... | |
Protected Attributes | |
| $resultSet | |
| $terms | |
| $totalHits | |
| Protected Attributes inherited from SearchResultSet | |
| $containedSyntax = false | |
| Types of interwiki results. More... | |
| array[] | $extraData = [] |
| Set of result's extra data, indexed per result id and then per data item name. More... | |
Detailed Description
This class is used for different SQL-based search engines shipped with MediaWiki.
Definition at line 6 of file SqlSearchResultSet.php.
Constructor & Destructor Documentation
| SqlSearchResultSet::__construct | ( | ResultWrapper | $resultSet, |
| $terms, | |||
$total = null |
|||
| ) |
Definition at line 11 of file SqlSearchResultSet.php.
References $resultSet, and $terms.
Member Function Documentation
| SqlSearchResultSet::free | ( | ) |
Definition at line 50 of file SqlSearchResultSet.php.
| SqlSearchResultSet::getTotalHits | ( | ) |
Definition at line 58 of file SqlSearchResultSet.php.
References $totalHits, and numRows().
| SqlSearchResultSet::next | ( | ) |
Definition at line 29 of file SqlSearchResultSet.php.
References Title\makeTitle(), and SearchResult\newFromTitle().
| SqlSearchResultSet::numRows | ( | ) |
Definition at line 21 of file SqlSearchResultSet.php.
Referenced by getTotalHits().
| SqlSearchResultSet::rewind | ( | ) |
Definition at line 44 of file SqlSearchResultSet.php.
| SqlSearchResultSet::termMatches | ( | ) |
Definition at line 17 of file SqlSearchResultSet.php.
References $terms.
Member Data Documentation
|
protected |
Definition at line 7 of file SqlSearchResultSet.php.
Referenced by __construct().
|
protected |
Definition at line 8 of file SqlSearchResultSet.php.
Referenced by __construct(), and termMatches().
|
protected |
Definition at line 9 of file SqlSearchResultSet.php.
Referenced by getTotalHits().
The documentation for this class was generated from the following file:
- includes/search/SqlSearchResultSet.php
