MediaWiki REL1_39
BaseSearchResultSet Class Reference

BaseSearchResultSet is the base class that must be extended by SearchEngine search result set implementations. More...

Inheritance diagram for BaseSearchResultSet:
Collaboration diagram for BaseSearchResultSet:

Public Member Functions

 free ()
 Frees the result set, if applicable.
 
 next ()
 Fetches next search result, or false.
 
 rewind ()
 Rewind result set back to beginning.
 
 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.
 
- Public Member Functions inherited from ISearchResultSet
 augmentResult (SearchResult $result)
 Returns extra data for specific result and store it in SearchResult object.
 
 extractResults ()
 Extract all the results in the result set as array.
 
 extractTitles ()
 Extract all the titles in the result set.
 
 getInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Return a result set of hits on other (multiple) wikis associated with this one.
 
 getOffset ()
 
 getQueryAfterRewrite ()
 
 getQueryAfterRewriteSnippet ()
 
 getSuggestionQuery ()
 
 getSuggestionSnippet ()
 
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database.
 
 hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Check if there are results on other wikis.
 
 hasMoreResults ()
 
 hasRewrittenQuery ()
 Some search modes will run an alternative query that it thinks gives a better result than the provided search.
 
 hasSuggestion ()
 Some search modes return a suggested alternate term if there are no exact hits.
 
 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.
 
 setAugmentedData ( $name, $data)
 Sets augmented data for result set.
 
 shrink ( $limit)
 

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.
 
const SECONDARY_RESULTS = 0
 Identifier for interwiki results that are displayed only together with existing main wiki results.
 

Detailed Description

BaseSearchResultSet is the base class that must be extended by SearchEngine search result set implementations.

This base class is meant to hold B/C behaviors and to be useful it must never:

  • be used as type hints (ISearchResultSet must be used for this)
  • implement a constructor
  • declare utility methods
Stability: stable
to extend

Definition at line 15 of file BaseSearchResultSet.php.

Member Function Documentation

◆ free()

BaseSearchResultSet::free ( )

Frees the result set, if applicable.

Deprecated
noop since 1.34

Definition at line 77 of file BaseSearchResultSet.php.

◆ next()

BaseSearchResultSet::next ( )

Fetches next search result, or false.

Deprecated
since 1.32; Use self::extractResults() or foreach
Returns
SearchResult|false

Definition at line 27 of file BaseSearchResultSet.php.

References wfDeprecated().

◆ rewind()

BaseSearchResultSet::rewind ( )

Rewind result set back to beginning.

Deprecated
since 1.32; Use self::extractResults() or foreach

Definition at line 39 of file BaseSearchResultSet.php.

References wfDeprecated().

◆ termMatches()

BaseSearchResultSet::termMatches ( )

Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.

STUB

Returns
string[]
Deprecated
since 1.34 (use SqlSearchResult)

Reimplemented in SqlSearchResultSet.

Definition at line 69 of file BaseSearchResultSet.php.


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