MediaWiki master
MediaWiki\Search\SearchNearMatchResultSet Class Reference

A ISearchResultSet wrapper for TitleMatcher. More...

Inherits MediaWiki\Search\SearchResultSet.

Collaboration diagram for MediaWiki\Search\SearchNearMatchResultSet:

Public Member Functions

 __construct ( $match)
 
 numRows ()
 
Returns
int

 
- Public Member Functions inherited from MediaWiki\Search\SearchResultSet
 __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.
 
 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 MediaWiki\Search\BaseSearchResultSet
 free ()
 Frees the result set, if applicable.
 
 isApproximateTotalHits ()
 If getTotalHits() is supported determine whether this number is approximate or not.Some engine might perform optimizations that might lead to inaccurate total hits. If this happens such engine should return true.
Returns
bool
Since
1.44

 
 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 MediaWiki\Search\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.
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Search\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.
 
- Protected Attributes inherited from MediaWiki\Search\SearchResultSet
bool $containedSyntax = false
 
SearchResult[] $results
 Cache of results - serialization of the result iterator as an array.
 

Detailed Description

A ISearchResultSet wrapper for TitleMatcher.

Definition at line 10 of file SearchNearMatchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SearchNearMatchResultSet::__construct ( $match)
Parameters
Title | null$matchTitle if matched, else null

Definition at line 14 of file SearchNearMatchResultSet.php.

References MediaWiki\Search\SearchResult\newFromTitle().

Member Function Documentation

◆ numRows()

MediaWiki\Search\SearchNearMatchResultSet::numRows ( )

Returns
int

Reimplemented from MediaWiki\Search\SearchResultSet.

Definition at line 23 of file SearchNearMatchResultSet.php.


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