Public Member Functions | |
| free () | |
| Frees the result set, if applicable. More... | |
| getInterwikiResults () | |
| Return a result set of hits on other (multiple) wikis associated with this one. More... | |
| getSuggestionQuery () | |
| getSuggestionSnippet () | |
| getTotalHits () | |
| Some search modes return a total hit count for the query in the entire article database. More... | |
| hasInterwikiResults () | |
| Check if there are results on other wikis. More... | |
| hasResults () | |
| Return true if results are included in this result set. 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 () | |
| 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... | |
| termMatches () | |
| Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. More... | |
Detailed Description
Definition at line 27 of file SearchResultSet.php.
Member Function Documentation
◆ free()
| SearchResultSet::free | ( | ) |
Frees the result set, if applicable.
Reimplemented in SqlSearchResultSet.
Definition at line 122 of file SearchResultSet.php.
◆ getInterwikiResults()
| SearchResultSet::getInterwikiResults | ( | ) |
Return a result set of hits on other (multiple) wikis associated with this one.
- Returns
- SearchResultSet
Definition at line 96 of file SearchResultSet.php.
Referenced by hasInterwikiResults().
◆ getSuggestionQuery()
| SearchResultSet::getSuggestionQuery | ( | ) |
- Returns
- String: suggested query, null if none
Definition at line 80 of file SearchResultSet.php.
◆ getSuggestionSnippet()
| SearchResultSet::getSuggestionSnippet | ( | ) |
- Returns
- String: HTML highlighted suggested query, '' if none
Definition at line 87 of file SearchResultSet.php.
◆ getTotalHits()
| 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.
- Returns
- Integer
Reimplemented in MySQLSearchResultSet, and SqliteSearchResultSet.
Definition at line 63 of file SearchResultSet.php.
◆ hasInterwikiResults()
| SearchResultSet::hasInterwikiResults | ( | ) |
Check if there are results on other wikis.
- Returns
- Boolean
Definition at line 105 of file SearchResultSet.php.
References getInterwikiResults().
◆ hasResults()
| SearchResultSet::hasResults | ( | ) |
Return true if results are included in this result set.
STUB
- Returns
- Boolean
Definition at line 49 of file SearchResultSet.php.
Referenced by SearchNearMatchResultSet\numRows().
◆ hasSuggestion()
| 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.
- Returns
- Boolean
Definition at line 73 of file SearchResultSet.php.
◆ next()
| SearchResultSet::next | ( | ) |
Fetches next search result, or false.
STUB
- Returns
- SearchResult
Reimplemented in PostgresSearchResultSet, MssqlSearchResultSet, SearchNearMatchResultSet, and SqlSearchResultSet.
Definition at line 115 of file SearchResultSet.php.
◆ numRows()
| SearchResultSet::numRows | ( | ) |
Reimplemented in MssqlSearchResultSet, SearchNearMatchResultSet, and SqlSearchResultSet.
Definition at line 39 of file SearchResultSet.php.
◆ searchContainedSyntax()
| 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.
Definition at line 131 of file SearchResultSet.php.
◆ termMatches()
| SearchResultSet::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 in MssqlSearchResultSet, and SqlSearchResultSet.
Definition at line 35 of file SearchResultSet.php.
References array().
The documentation for this class was generated from the following file:
- includes/search/SearchResultSet.php
