Inheritance diagram for SearchResultSet:

Collaboration diagram for SearchResultSet:

Public Member Functions
	__construct ($containedSyntax=false)

	augmentResult (SearchResult $result)
	Returns extra data for specific result and store it in SearchResult object. More...

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

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

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

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

Protected Attributes
	$containedSyntax = false
	Types of interwiki results. More...

array[]	$extraData = []
	Set of result's extra data, indexed per result id and then per data item name. More...

Private Attributes
SearchResult[]	$results
	Cache of results - serialization of the result iterator as an array. More...

Title[]	$titles
	Cache of titles. More...

Detailed Description

Definition at line 27 of file SearchResultSet.php.

Constructor & Destructor Documentation

SearchResultSet::__construct ( $containedSyntax = false )

Definition at line 68 of file SearchResultSet.php.

References $containedSyntax.

Member Function Documentation

SearchResultSet::augmentResult ( SearchResult $result )

Returns extra data for specific result and store it in SearchResult object.

Parameters

SearchResult $result

Returns: array|null List of data as name => value or null if none present.

Definition at line 259 of file SearchResultSet.php.

References SearchResult\getTitle(), and SearchResult\setExtensionData().

SearchResultSet::extractResults ( )

Extract all the results in the result set as array.

Returns: SearchResult[]

Definition at line 207 of file SearchResultSet.php.

References $results, next(), numRows(), and rewind().

Referenced by PerRowAugmentor\augmentAll(), and extractTitles().

SearchResultSet::extractTitles ( )

Extract all the titles in the result set.

Returns: Title[]

Definition at line 227 of file SearchResultSet.php.

References $titles, extractResults(), SearchResult\getTitle(), and numRows().

Referenced by AugmentPageProps\augmentAll().

SearchResultSet::free ( )

Frees the result set, if applicable.

Definition at line 189 of file SearchResultSet.php.

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

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

Returns: SearchResultSet[]

Definition at line 157 of file SearchResultSet.php.

SearchResultSet::getQueryAfterRewrite ( )

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

Definition at line 116 of file SearchResultSet.php.

Referenced by SpecialSearch\getDidYouMeanRewrittenHtml().

SearchResultSet::getQueryAfterRewriteSnippet ( )

Returns: string|null Same as self::getQueryAfterRewrite(), but in HTML and with changes highlighted. Null when the query was not rewritten.

Definition at line 124 of file SearchResultSet.php.

Referenced by SpecialSearch\getDidYouMeanRewrittenHtml().

SearchResultSet::getSuggestionQuery ( )

Returns: string|null Suggested query, null if none

Definition at line 141 of file SearchResultSet.php.

Referenced by SpecialSearch\getDidYouMeanHtml().

SearchResultSet::getSuggestionSnippet ( )

Returns: string HTML highlighted suggested query, '' if none

Definition at line 148 of file SearchResultSet.php.

Referenced by SpecialSearch\getDidYouMeanHtml().

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

Definition at line 97 of file SearchResultSet.php.

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

Check if there are results on other wikis.

Returns: bool

Definition at line 166 of file SearchResultSet.php.

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 occured.

Returns: bool

Definition at line 108 of file SearchResultSet.php.

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

Definition at line 134 of file SearchResultSet.php.

Referenced by SpecialSearch\shouldRunSuggestedQuery().

SearchResultSet::next ( )

Fetches next search result, or false.

STUB FIXME: refactor as iterator, so we could use nicer interfaces.

Returns: SearchResult|false

Definition at line 176 of file SearchResultSet.php.

Referenced by SearchEngineTest\addAugmentors(), and extractResults().

SearchResultSet::numRows ( )

Definition at line 83 of file SearchResultSet.php.

Referenced by extractResults(), extractTitles(), and SpecialSearch\shouldRunSuggestedQuery().

SearchResultSet::rewind ( )

Rewind result set back to beginning.

Definition at line 183 of file SearchResultSet.php.

Referenced by SearchEngineTest\addAugmentors(), and extractResults().

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

Definition at line 199 of file SearchResultSet.php.

References $containedSyntax.

Referenced by SpecialSearch\shouldRunSuggestedQuery().

SearchResultSet::setAugmentedData	(	$name,
		$data
	)

Sets augmented data for result set.

Parameters

string	$name	Extra data item name
	array[]	$data Extra data as PAGEID => data

Definition at line 248 of file SearchResultSet.php.

References $name, and as.

Referenced by SearchEngine\augmentSearchResults().

SearchResultSet::termMatches ( )

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

STUB

Returns: array

Definition at line 79 of file SearchResultSet.php.

Member Data Documentation

SearchResultSet::$containedSyntax = false

protected

Types of interwiki results.

Definition at line 43 of file SearchResultSet.php.

Referenced by __construct(), SpecialSearchTestMockResultSet\__construct(), and searchContainedSyntax().

array [] SearchResultSet::$extraData = []

protected

Set of result's extra data, indexed per result id and then per data item name.

The structure is: PAGE_ID => [ augmentor name => data, ... ]

Definition at line 66 of file SearchResultSet.php.

SearchResult [] SearchResultSet::$results

private

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

Definition at line 57 of file SearchResultSet.php.

Referenced by extractResults().

Title [] SearchResultSet::$titles

private

Cache of titles.

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

Definition at line 50 of file SearchResultSet.php.

Referenced by extractTitles().

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

includes/search/SearchResultSet.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation