MediaWiki  REL1_31
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 (ResultWrapper $resultSet, $terms, $total=null)
 
 free ()
 Frees the result set, if applicable. More...
 
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database. More...
 
 next ()
 Fetches next search result, or false. More...
 
 numRows ()
 
 rewind ()
 Rewind result set back to beginning. More...
 
 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
 __construct ( $containedSyntax=false)
 
 augmentResult (SearchResult $result)
 Returns extra data for specific result and store it in SearchResult object. More...
 
 extractResults ()
 Extract all the results in the result set as array. More...
 
 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...
 
 getOffset ()
 
 getQueryAfterRewrite ()
 
 getQueryAfterRewriteSnippet ()
 
 getSuggestionQuery ()
 
 getSuggestionSnippet ()
 
 hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Check if there are results on other wikis. More...
 
 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...
 
 setAugmentedData ( $name, $data)
 Sets augmented data for result set. More...
 

Protected Attributes

 $resultSet
 
 $terms
 
 $totalHits
 
- Protected Attributes inherited from SearchResultSet
 $containedSyntax = false
 Types of interwiki results. More...
 
array[] $extraData = []
 Set of result's extra data, indexed per result id and then per data item name. 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 ( ResultWrapper  $resultSet,
  $terms,
  $total = null 
)

Definition at line 14 of file SqlSearchResultSet.php.

References $resultSet, and $terms.

Member Function Documentation

◆ free()

SqlSearchResultSet::free ( )

Frees the result set, if applicable.

Reimplemented from SearchResultSet.

Definition at line 53 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 61 of file SqlSearchResultSet.php.

References $totalHits, and numRows().

◆ next()

SqlSearchResultSet::next ( )

Fetches next search result, or false.

STUB FIXME: refactor as iterator, so we could use nicer interfaces.

Returns
SearchResult|false

Reimplemented from SearchResultSet.

Definition at line 32 of file SqlSearchResultSet.php.

References Title\makeTitle(), and SearchResult\newFromTitle().

◆ numRows()

SqlSearchResultSet::numRows ( )

Reimplemented from SearchResultSet.

Definition at line 24 of file SqlSearchResultSet.php.

Referenced by getTotalHits().

◆ rewind()

SqlSearchResultSet::rewind ( )

Rewind result set back to beginning.

Reimplemented from SearchResultSet.

Definition at line 47 of file SqlSearchResultSet.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 20 of file SqlSearchResultSet.php.

References $terms.

Member Data Documentation

◆ $resultSet

SqlSearchResultSet::$resultSet
protected

Definition at line 10 of file SqlSearchResultSet.php.

Referenced by __construct().

◆ $terms

SqlSearchResultSet::$terms
protected

Definition at line 11 of file SqlSearchResultSet.php.

Referenced by __construct(), and termMatches().

◆ $totalHits

SqlSearchResultSet::$totalHits
protected

Definition at line 12 of file SqlSearchResultSet.php.

Referenced by getTotalHits().


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