MediaWiki  1.34.0
SqlSearchResultSet Class Reference

This class is used for different SQL-based search engines shipped with MediaWiki. More...

Inheritance diagram for SqlSearchResultSet:
Collaboration diagram for SqlSearchResultSet:

Public Member Functions

 __construct (IResultWrapper $resultSet, array $terms, $total=null)
 
 extractResults ()
 Extract all the results in the result set as array. More...
 
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database. More...
 
 numRows ()
 
 termMatches ()
 
- Public Member Functions inherited from SearchResultSet
 __construct ( $containedSyntax=false, $hasMoreResults=false)
 
 count ()
 
 extractTitles ()
 Extract all the titles in the result set. 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 ()
 
 hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Check if there are results on other wikis. More...
 
 hasMoreResults ()
 
 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...
 
 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...
 
 shrink ( $limit)
 
- Public Member Functions inherited from BaseSearchResultSet
 free ()
 Frees the result set, if applicable. More...
 
 next ()
 Fetches next search result, or false. More...
 
 rewind ()
 Rewind result set back to beginning. More...
 
- Public Member Functions inherited from ISearchResultSet
 augmentResult (SearchResult $result)
 Returns extra data for specific result and store it in SearchResult object. More...
 
 getOffset ()
 
 setAugmentedData ( $name, $data)
 Sets augmented data for result set. More...
 

Protected Attributes

IResultWrapper $resultSet
 @noinspection PhpMissingParentConstructorInspection More...
 
string[] $terms
 Requested search query. More...
 
int null $totalHits
 Total number of hits for $terms. More...
 
- Protected Attributes inherited from SearchResultSet
 $containedSyntax = false
 
SearchResult[] $results
 Cache of results - serialization of the result iterator as an array. More...
 

Additional Inherited Members

- Public Attributes inherited from ISearchResultSet
const INLINE_RESULTS = 1
 Identifier for interwiki results that can be displayed even if no existing main wiki results exist. More...
 
const SECONDARY_RESULTS = 0
 Identifier for interwiki results that are displayed only together with existing main wiki results. More...
 

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 ( IResultWrapper  $resultSet,
array  $terms,
  $total = null 
)
Parameters
IResultWrapper$resultSet
string[]$terms
int | null$total

Definition at line 24 of file SqlSearchResultSet.php.

References $resultSet, 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 47 of file SqlSearchResultSet.php.

References SearchResultSet\$results, $terms, ISearchResultSet\augmentResult(), and Title\makeTitle().

◆ 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 69 of file SqlSearchResultSet.php.

References $totalHits, and numRows().

◆ numRows()

SqlSearchResultSet::numRows ( )
Returns
int

Reimplemented from SearchResultSet.

Definition at line 39 of file SqlSearchResultSet.php.

Referenced by getTotalHits().

◆ termMatches()

SqlSearchResultSet::termMatches ( )
Returns
string[]
Deprecated:
since 1.34

Reimplemented from BaseSearchResultSet.

Definition at line 35 of file SqlSearchResultSet.php.

References $terms.

Member Data Documentation

◆ $resultSet

IResultWrapper SqlSearchResultSet::$resultSet
protected

@noinspection PhpMissingParentConstructorInspection

Result object from database

Definition at line 13 of file SqlSearchResultSet.php.

Referenced by __construct().

◆ $terms

string [] SqlSearchResultSet::$terms
protected

Requested search query.

Definition at line 15 of file SqlSearchResultSet.php.

Referenced by __construct(), extractResults(), and termMatches().

◆ $totalHits

int null SqlSearchResultSet::$totalHits
protected

Total number of hits for $terms.

Definition at line 17 of file SqlSearchResultSet.php.

Referenced by getTotalHits().


The documentation for this class was generated from the following file: