MediaWiki REL1_35
SearchResultSet Class Reference
Inheritance diagram for SearchResultSet:
Collaboration diagram for SearchResultSet:

Public Member Functions

 __construct ( $containedSyntax=false, $hasMoreResults=false)
 
 count ()
 
 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.
 
 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.
 
 shrink ( $limit)
 
- Public Member Functions inherited from BaseSearchResultSet
 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.
 
 getOffset ()
 
 setAugmentedData ( $name, $data)
 Sets augmented data for result set.
 

Protected Attributes

 $containedSyntax = false
 
SearchResult[] $results
 Cache of results - serialization of the result iterator as an array.
 

Private Attributes

boolean $hasMoreResults
 True when there are more pages of search results available.
 
Title[] $titles
 Cache of titles.
 

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

Definition at line 27 of file SearchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

SearchResultSet::__construct (   $containedSyntax = false,
  $hasMoreResults = false 
)
Parameters
bool$containedSyntaxTrue when query is not requesting a simple term match
bool$hasMoreResultsTrue when there are more pages of search results available.

Definition at line 57 of file SearchResultSet.php.

References $containedSyntax, $hasMoreResults, hasMoreResults(), and wfDeprecated().

Member Function Documentation

◆ count()

SearchResultSet::count ( )
final

Definition at line 72 of file SearchResultSet.php.

Referenced by FauxSearchResultSet\__construct(), and numRows().

◆ extractResults()

SearchResultSet::extractResults ( )

Extract all the results in the result set as array.

Returns
SearchResult[]

Implements ISearchResultSet.

Reimplemented in SqlSearchResultSet.

Definition at line 205 of file SearchResultSet.php.

◆ extractTitles()

SearchResultSet::extractTitles ( )

Extract all the titles in the result set.

Returns
Title[]

Implements ISearchResultSet.

Definition at line 225 of file SearchResultSet.php.

◆ getInterwikiResults()

SearchResultSet::getInterwikiResults (   $type = self::SECONDARY_RESULTS)

Return a result set of hits on other (multiple) wikis associated with this one.

Parameters
int$type
Returns
ISearchResultSet[]

Implements ISearchResultSet.

Definition at line 148 of file SearchResultSet.php.

◆ getQueryAfterRewrite()

SearchResultSet::getQueryAfterRewrite ( )
Returns
string|null The search the query was internally rewritten to, or null when the result of the original query was returned.

Implements ISearchResultSet.

Definition at line 105 of file SearchResultSet.php.

◆ getQueryAfterRewriteSnippet()

SearchResultSet::getQueryAfterRewriteSnippet ( )
Returns
HtmlArmor|string|null Same as self::getQueryAfterRewrite(), but with changes highlighted if HtmlArmor is returned. Null when the query was not rewritten.

Implements ISearchResultSet.

Definition at line 114 of file SearchResultSet.php.

◆ getSuggestionQuery()

SearchResultSet::getSuggestionQuery ( )
Returns
string|null Suggested query, null if none

Implements ISearchResultSet.

Definition at line 131 of file SearchResultSet.php.

◆ getSuggestionSnippet()

SearchResultSet::getSuggestionSnippet ( )
Returns
HtmlArmor|string HTML highlighted suggested query, '' if none

Implements ISearchResultSet.

Definition at line 138 of file SearchResultSet.php.

◆ getTotalHits()

SearchResultSet::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

Implements ISearchResultSet.

Reimplemented in FauxSearchResultSet, and SqlSearchResultSet.

Definition at line 86 of file SearchResultSet.php.

◆ hasInterwikiResults()

SearchResultSet::hasInterwikiResults (   $type = self::SECONDARY_RESULTS)

Check if there are results on other wikis.

Parameters
int$type
Returns
bool

Implements ISearchResultSet.

Definition at line 158 of file SearchResultSet.php.

◆ hasMoreResults()

SearchResultSet::hasMoreResults ( )
Returns
bool True when there are more pages of search results available.

Implements ISearchResultSet.

Definition at line 175 of file SearchResultSet.php.

Referenced by __construct().

◆ hasRewrittenQuery()

SearchResultSet::hasRewrittenQuery ( )

Some search modes will run an alternative query that it thinks gives a better result than the provided search.

Returns true if this has occurred.

Returns
bool

Implements ISearchResultSet.

Definition at line 97 of file SearchResultSet.php.

◆ hasSuggestion()

SearchResultSet::hasSuggestion ( )

Some search modes return a suggested alternate term if there are no exact hits.

Returns true if there is one on this set.

Returns
bool

Implements ISearchResultSet.

Definition at line 124 of file SearchResultSet.php.

◆ numRows()

SearchResultSet::numRows ( )
Returns
int

Implements ISearchResultSet.

Reimplemented in SearchNearMatchResultSet, and SqlSearchResultSet.

Definition at line 68 of file SearchResultSet.php.

References count().

◆ searchContainedSyntax()

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

Returns
bool

Implements ISearchResultSet.

Definition at line 168 of file SearchResultSet.php.

◆ shrink()

SearchResultSet::shrink (   $limit)
Parameters
int$limitShrink result set to $limit and flag if more results are available.

Implements ISearchResultSet.

Definition at line 183 of file SearchResultSet.php.

Member Data Documentation

◆ $containedSyntax

SearchResultSet::$containedSyntax = false
protected

Definition at line 30 of file SearchResultSet.php.

Referenced by __construct().

◆ $hasMoreResults

boolean SearchResultSet::$hasMoreResults
private

True when there are more pages of search results available.

Definition at line 49 of file SearchResultSet.php.

Referenced by __construct(), and FauxSearchResultSet\__construct().

◆ $results

SearchResult [] SearchResultSet::$results
protected

Cache of results - serialization of the result iterator as an array.

Definition at line 44 of file SearchResultSet.php.

Referenced by FauxSearchResultSet\__construct(), and SqlSearchResultSet\extractResults().

◆ $titles

Title [] SearchResultSet::$titles
private

Cache of titles.

Lists titles of the result set, in the same order as results.

Definition at line 37 of file SearchResultSet.php.


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