MediaWiki  1.23.2
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 ( $resultSet, $terms)
 
 free ()
 Frees the result set, if applicable. More...
 
 next ()
 Fetches next search result, or false. More...
 
 numRows ()
 
 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. More...
 
- Public Member Functions inherited from SearchResultSet
 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...
 
 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...
 

Protected Attributes

 $mResultSet
 

Detailed Description

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

Definition at line 140 of file SearchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

SqlSearchResultSet::__construct (   $resultSet,
  $terms 
)

Reimplemented in PostgresSearchResultSet.

Definition at line 144 of file SearchResultSet.php.

Member Function Documentation

◆ free()

SqlSearchResultSet::free ( )

Frees the result set, if applicable.

Reimplemented from SearchResultSet.

Definition at line 174 of file SearchResultSet.php.

◆ next()

SqlSearchResultSet::next ( )

Fetches next search result, or false.

STUB

Returns
SearchResult

Reimplemented from SearchResultSet.

Reimplemented in PostgresSearchResultSet.

Definition at line 161 of file SearchResultSet.php.

References SearchResult\newFromRow().

◆ numRows()

SqlSearchResultSet::numRows ( )

Reimplemented from SearchResultSet.

Definition at line 153 of file SearchResultSet.php.

◆ 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 149 of file SearchResultSet.php.

Member Data Documentation

◆ $mResultSet

SqlSearchResultSet::$mResultSet
protected

Definition at line 142 of file SearchResultSet.php.


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