This class is used for different SQL-based search engines shipped with MediaWiki. More...
Public Member Functions | |
| __construct (ResultWrapper $resultSet, $terms, $total=null) | |
| extractResults () | |
| Extract all the results in the result set as array. | |
| free () | |
| Frees the result set, if applicable. | |
| getTotalHits () | |
| Some search modes return a total hit count for the query in the entire article database. | |
| numRows () | |
| 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 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. | |
| getInterwikiResults ( $type=self::SECONDARY_RESULTS) | |
| Return a result set of hits on other (multiple) wikis associated with this one. | |
| getIterator () | |
| getOffset () | |
| 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. | |
| 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) | |
Protected Attributes | |
| ResultWrapper | $resultSet |
| Result object from database. | |
| string | $terms |
| Requested search query. | |
| int null | $totalHits |
| Total number of hits for $terms. | |
| 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
This class is used for different SQL-based search engines shipped with MediaWiki.
Definition at line 9 of file SqlSearchResultSet.php.
Constructor & Destructor Documentation
◆ __construct()
| SqlSearchResultSet::__construct | ( | ResultWrapper | $resultSet, |
| $terms, | |||
| $total = null ) |
Definition at line 17 of file SqlSearchResultSet.php.
References $resultSet, $terms, and terms.
Member Function Documentation
◆ extractResults()
| SqlSearchResultSet::extractResults | ( | ) |
Extract all the results in the result set as array.
- Returns
- SearchResult[]
Reimplemented from SearchResultSet.
Definition at line 35 of file SqlSearchResultSet.php.
References SearchResultSet\$results.
◆ free()
| SqlSearchResultSet::free | ( | ) |
Frees the result set, if applicable.
Reimplemented from SearchResultSet.
Definition at line 52 of file SqlSearchResultSet.php.
◆ getTotalHits()
| SqlSearchResultSet::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
Reimplemented from SearchResultSet.
Definition at line 60 of file SqlSearchResultSet.php.
References $totalHits, and(), and numRows().
◆ numRows()
| SqlSearchResultSet::numRows | ( | ) |
Reimplemented from SearchResultSet.
Definition at line 27 of file SqlSearchResultSet.php.
Referenced by getTotalHits().
◆ termMatches()
| SqlSearchResultSet::termMatches | ( | ) |
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.
STUB
- Returns
- array
Reimplemented from SearchResultSet.
Definition at line 23 of file SqlSearchResultSet.php.
References $terms.
Member Data Documentation
◆ $resultSet
|
protected |
Result object from database.
Definition at line 11 of file SqlSearchResultSet.php.
Referenced by __construct().
◆ $terms
|
protected |
Requested search query.
Definition at line 13 of file SqlSearchResultSet.php.
Referenced by __construct(), and termMatches().
◆ $totalHits
|
protected |
Total number of hits for $terms.
Definition at line 15 of file SqlSearchResultSet.php.
Referenced by getTotalHits().
The documentation for this class was generated from the following file:
- includes/search/SqlSearchResultSet.php
