CirrusSearch\Search\FancyTitleResultsType Class Reference

Returns titles categorized based on how they matched - redirect or name. More...

Inheritance diagram for CirrusSearch\Search\FancyTitleResultsType:

Collaboration diagram for CirrusSearch\Search\FancyTitleResultsType:

Public Member Functions
	__construct ( $matchedAnalyzer, TitleHelper $titleHelper=null)
	Build result type.
	getSourceFiltering ()
	getHighlightingConfiguration (array $extraHighlightFields=[])
	transformElasticsearchResult (ElasticaResultSet $resultSet)
	Convert the results to titles.
	createEmptyResult ()
	transformOneElasticResult (\Elastica\Result $r, array $namespaces=[])
	Transform a result from elastic into an array of Titles.
Public Member Functions inherited from CirrusSearch\Search\TitleResultsType
	__construct (TitleHelper $titleHelper=null)
	getFields ()
	getTitleHelper ()

Static Public Member Functions
static	chooseBestTitleOrRedirect (array $match)
	Finds best title or redirect.

Detailed Description

Returns titles categorized based on how they matched - redirect or name.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Search\FancyTitleResultsType::__construct	(		$matchedAnalyzer,
		TitleHelper	$titleHelper = null )

Build result type.

The matchedAnalyzer is required to detect if the match was from the title or a redirect (and is kind of a leaky abstraction.)

Parameters

string	$matchedAnalyzer	the analyzer used to match the title
TitleHelper | null	$titleHelper

Member Function Documentation

chooseBestTitleOrRedirect()

static CirrusSearch\Search\FancyTitleResultsType::chooseBestTitleOrRedirect ( array $match )

static

Finds best title or redirect.

Parameters

array

$match

array returned by self::transformOneElasticResult

Returns

Title|false choose best

createEmptyResult()

CirrusSearch\Search\FancyTitleResultsType::createEmptyResult

(

)

Returns

array

Reimplemented from CirrusSearch\Search\TitleResultsType.

getHighlightingConfiguration()

CirrusSearch\Search\FancyTitleResultsType::getHighlightingConfiguration

(

array

$extraHighlightFields = []

)

Parameters

array

$extraHighlightFields

Returns

array|null

Reimplemented from CirrusSearch\Search\TitleResultsType.

getSourceFiltering()

CirrusSearch\Search\FancyTitleResultsType::getSourceFiltering

(

)

Returns

false|string|array corresponding to Elasticsearch source filtering syntax

Reimplemented from CirrusSearch\Search\BaseResultsType.

transformElasticsearchResult()

CirrusSearch\Search\FancyTitleResultsType::transformElasticsearchResult

(

ElasticaResultSet

$resultSet

)

Convert the results to titles.

Parameters

ElasticaResultSet

$resultSet

Returns

array[] Array of arrays, each with optional keys: titleMatch => a title if the title matched redirectMatches => an array of redirect matches, one per matched redirect

Reimplemented from CirrusSearch\Search\TitleResultsType.

transformOneElasticResult()

CirrusSearch\Search\FancyTitleResultsType::transformOneElasticResult	(	\Elastica\Result	$r,
		array	$namespaces = [] )

Transform a result from elastic into an array of Titles.

Parameters

\Elastica\Result	$r
int[]	$namespaces	Prefer

Returns

Title[] with the following keys : titleMatch => a title if the title matched redirectMatches => an array of redirect matches, one per matched redirect

---

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

• includes/Search/FancyTitleResultsType.php