MediaWiki  1.23.0
MySQLSearchResultSet Class Reference
Inheritance diagram for MySQLSearchResultSet:
Collaboration diagram for MySQLSearchResultSet:

Public Member Functions

 __construct ( $resultSet, $terms, $totalHits=null)
 
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database. More...
 
- Public Member Functions inherited from SqlSearchResultSet
 __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 ()
 
 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...
 

Additional Inherited Members

- Protected Attributes inherited from SqlSearchResultSet
 $mResultSet
 

Detailed Description

Definition at line 459 of file SearchMySQL.php.

Constructor & Destructor Documentation

◆ __construct()

MySQLSearchResultSet::__construct (   $resultSet,
  $terms,
  $totalHits = null 
)

Definition at line 460 of file SearchMySQL.php.

Member Function Documentation

◆ getTotalHits()

MySQLSearchResultSet::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 from SearchResultSet.

Definition at line 465 of file SearchMySQL.php.


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