MediaWiki REL1_28
SearchNearMatchResultSet Class Reference

A SearchResultSet wrapper for SearchNearMatcher. More...

Inheritance diagram for SearchNearMatchResultSet:
Collaboration diagram for SearchNearMatchResultSet:

Public Member Functions

 __construct ( $match)
 
 next ()
 Fetches next search result, or false.
 
 numRows ()
 
 rewind ()
 Rewind result set back to beginning.
 
- Public Member Functions inherited from SearchResultSet
 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.
 
 free ()
 Frees the result set, if applicable.
 
 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.
 
 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.
 
 setAugmentedData ( $name, $data)
 Sets augmented data for result set.
 
 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.
 

Private Attributes

 $fetched = false
 

Additional Inherited Members

- Protected Attributes inherited from SearchResultSet
 $containedSyntax = false
 Types of interwiki results.
 
array[] $extraData = []
 Set of result's extra data, indexed per result id and then per data item name.
 

Detailed Description

A SearchResultSet wrapper for SearchNearMatcher.

Definition at line 5 of file SearchNearMatchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from SearchResultSet.

Definition at line 11 of file SearchNearMatchResultSet.php.

Member Function Documentation

◆ next()

SearchNearMatchResultSet::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 19 of file SearchNearMatchResultSet.php.

References SearchResult\newFromTitle().

◆ numRows()

SearchNearMatchResultSet::numRows ( )

Reimplemented from SearchResultSet.

Definition at line 15 of file SearchNearMatchResultSet.php.

◆ rewind()

SearchNearMatchResultSet::rewind ( )

Rewind result set back to beginning.

Reimplemented from SearchResultSet.

Definition at line 27 of file SearchNearMatchResultSet.php.

Member Data Documentation

◆ $fetched

SearchNearMatchResultSet::$fetched = false
private

Definition at line 6 of file SearchNearMatchResultSet.php.


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