MediaWiki  master
MockSearchResultSet Class Reference
Inheritance diagram for MockSearchResultSet:
Collaboration diagram for MockSearchResultSet:

Public Member Functions

 __construct (array $results, array $interwikiResults=[])
 
 extractResults ()
 
 getInterwikiResults ( $type=self::SECONDARY_RESULTS)
 
 hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
 
 numRows ()
 
- Public Member Functions inherited from SearchResultSet
 __construct ( $containedSyntax=false, $hasMoreResults=false)
 
 augmentResult (SearchResult $result)
 Returns extra data for specific result and store it in SearchResult object. More...
 
 count ()
 
 extractResults ()
 Extract all the results in the result set as array. More...
 
 extractTitles ()
 Extract all the titles in the result set. More...
 
 free ()
 Frees the result set, if applicable. More...
 
 getInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Return a result set of hits on other (multiple) wikis associated with this one. More...
 
 getIterator ()
 
 getOffset ()
 
 getQueryAfterRewrite ()
 
 getQueryAfterRewriteSnippet ()
 
 getSuggestionQuery ()
 
 getSuggestionSnippet ()
 
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database. More...
 
 hasInterwikiResults ( $type=self::SECONDARY_RESULTS)
 Check if there are results on other wikis. More...
 
 hasMoreResults ()
 
 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...
 
 next ()
 Fetches next search result, or false. More...
 
 numRows ()
 
 rewind ()
 Rewind result set back to beginning. 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...
 
 shrink ( $limit)
 
 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. More...
 

Private Attributes

 $interwikiResults
 

Additional Inherited Members

- Public Attributes inherited from SearchResultSet
const INLINE_RESULTS = 1
 Identifier for interwiki results that can be displayed even if no existing main wiki results exist. More...
 
const SECONDARY_RESULTS = 0
 Identifier for interwiki results that are displayed only together with existing main wiki results. More...
 
- Protected Attributes inherited from SearchResultSet
 $containedSyntax = false
 
array [] $extraData = []
 Set of result's extra data, indexed per result id and then per data item name. More...
 
SearchResult [] $results
 Cache of results - serialization of the result iterator as an array. More...
 

Detailed Description

Definition at line 3 of file MockSearchResultSet.php.

Constructor & Destructor Documentation

◆ __construct()

MockSearchResultSet::__construct ( array  $results,
array  $interwikiResults = [] 
)
Parameters
SearchResult[]|callable[]$results
SearchResultSet[][]|callable[][]$interwikiResults Map from result type to list of results for that type.

Definition at line 15 of file MockSearchResultSet.php.

References $interwikiResults, and SearchResultSet\$results.

Member Function Documentation

◆ extractResults()

MockSearchResultSet::extractResults ( )

Definition at line 30 of file MockSearchResultSet.php.

References SearchResultSet\$results, and as.

◆ getInterwikiResults()

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

Definition at line 43 of file MockSearchResultSet.php.

References $type, hasInterwikiResults(), and null.

◆ hasInterwikiResults()

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

Definition at line 25 of file MockSearchResultSet.php.

References $type, and SearchResultSet\count().

Referenced by getInterwikiResults().

◆ numRows()

MockSearchResultSet::numRows ( )

Definition at line 21 of file MockSearchResultSet.php.

References SearchResultSet\count().

Member Data Documentation

◆ $interwikiResults

MockSearchResultSet::$interwikiResults
private

Definition at line 8 of file MockSearchResultSet.php.

Referenced by __construct().


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