CirrusSearch\Search\FullTextResultsType Class Reference

Result type for a full text search. More...

Inheritance diagram for CirrusSearch\Search\FullTextResultsType:

Collaboration diagram for CirrusSearch\Search\FullTextResultsType:

Public Member Functions
	__construct (FetchPhaseConfigBuilder $fetchPhaseBuilder, $searchContainedSyntax, TitleHelper $titleHelper, array $extraFieldsToExtract=[], bool $deduplicate=false)
	getSourceFiltering ()
	getFields ()
	getHighlightingConfiguration (array $extraHighlightFields=[])
	Setup highlighting.
	withFetchPhaseBuilder (FetchPhaseConfigBuilder $builder)
	createEmptyResult ()
Public Member Functions inherited from CirrusSearch\Search\ResultsType
	transformElasticsearchResult (ElasticaResultSet $resultSet)

Detailed Description

Result type for a full text search.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Search\FullTextResultsType::__construct	(	FetchPhaseConfigBuilder	$fetchPhaseBuilder,
			$searchContainedSyntax,
		TitleHelper	$titleHelper,
		array	$extraFieldsToExtract = [],
		bool	$deduplicate = false )

Parameters

FetchPhaseConfigBuilder	$fetchPhaseBuilder
bool	$searchContainedSyntax
TitleHelper	$titleHelper
string[]	$extraFieldsToExtract
bool	$deduplicate

Member Function Documentation

createEmptyResult()

CirrusSearch\Search\FullTextResultsType::createEmptyResult

(

)

Returns

CirrusSearchResultSet

Implements CirrusSearch\Search\ResultsType.

getFields()

CirrusSearch\Search\FullTextResultsType::getFields

(

)

Returns

array

Implements CirrusSearch\Search\ResultsType.

getHighlightingConfiguration()

CirrusSearch\Search\FullTextResultsType::getHighlightingConfiguration

(

array

$extraHighlightFields = []

)

Setup highlighting.

Don't fragment title because it is small. Get just one fragment from the text because that is all we will display. Get one fragment from redirect title and heading each or else they won't be sorted by score.

Parameters

array

$extraHighlightFields

(deprecated and ignored)

Returns

array|null of highlighting configuration

Implements CirrusSearch\Search\ResultsType.

getSourceFiltering()

CirrusSearch\Search\FullTextResultsType::getSourceFiltering

(

)

Returns

false|string|array corresponding to Elasticsearch source filtering syntax

Reimplemented from CirrusSearch\Search\BaseResultsType.

withFetchPhaseBuilder()

CirrusSearch\Search\FullTextResultsType::withFetchPhaseBuilder

(

FetchPhaseConfigBuilder

$builder

)

Parameters

FetchPhaseConfigBuilder

$builder

Returns

FullTextResultsType

---

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

• includes/Search/FullTextResultsType.php