CirrusSearch\CirrusSearchHookRunner Class Reference

Public Member Functions
	__construct (HookContainer $hookContainer)
	onCirrusSearchRegisterFullTextQueryClassifiers (Parser\ParsedQueryClassifiersRepository $repository)
	Register FullText query classifiers.
	onCirrusSearchAddQueryFeatures (SearchConfig $config, array &$extraFeatures)
	Register new search keywords.
	onCirrusSearchBuildDocumentParse (Document $document, Title $title, ?Content $content, ParserOutput $parserOutput, Connection $connection)
	Use of this hook is deprecated, integration should happen through content handler interfaces.
	onCirrusSearchSimilarityConfig (array &$similarityConfig)
	Register new similarity configurations.
	onCirrusSearchAnalysisConfig (array &$config, AnalysisConfigBuilder $analyisConfigBuilder)
	Alter the analysis configuration.
	onCirrusSearchMappingConfig (array &$mappingConfig, MappingConfigBuilder $mappingConfigBuilder)
	Alter the mapping configuration.
	onCirrusSearchProfileService (Profile\SearchProfileService $service)
	Register search profiles.
	onCirrusSearchScoreBuilder (array $definition, Search\SearchContext $context, ?BoostFunctionBuilder &$builder)

Member Function Documentation

onCirrusSearchAddQueryFeatures()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchAddQueryFeatures	(	SearchConfig	$config,
		array &	$extraFeatures )

Register new search keywords.

Parameters

SearchConfig	$config
SimpleKeywordFeature[]	&$extraFeatures

onCirrusSearchAnalysisConfig()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchAnalysisConfig	(	array &	$config,
		AnalysisConfigBuilder	$analyisConfigBuilder )

Alter the analysis configuration.

Parameters

array	&$config
AnalysisConfigBuilder	$analyisConfigBuilder

onCirrusSearchBuildDocumentParse()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchBuildDocumentParse	(	Document	$document,
		Title	$title,
		?Content	$content,
		ParserOutput	$parserOutput,
		Connection	$connection )

Use of this hook is deprecated, integration should happen through content handler interfaces.

Parameters

Document	$document
Title	$title
Content | null	$content
ParserOutput	$parserOutput
Connection	$connection

onCirrusSearchMappingConfig()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchMappingConfig	(	array &	$mappingConfig,
		MappingConfigBuilder	$mappingConfigBuilder )

Alter the mapping configuration.

Parameters

array	&$mappingConfig
MappingConfigBuilder	$mappingConfigBuilder

onCirrusSearchProfileService()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchProfileService

(

Profile\SearchProfileService

$service

)

Register search profiles.

Parameters

Profile\SearchProfileService

$service

onCirrusSearchRegisterFullTextQueryClassifiers()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchRegisterFullTextQueryClassifiers

(

Parser\ParsedQueryClassifiersRepository

$repository

)

Register FullText query classifiers.

Parameters

Parser\ParsedQueryClassifiersRepository

$repository

onCirrusSearchScoreBuilder()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchScoreBuilder	(	array	$definition,
		Search\SearchContext	$context,
		?BoostFunctionBuilder &	$builder )

Parameters

array	$definition
Search\SearchContext	$context
BoostFunctionBuilder | null	&$builder

onCirrusSearchSimilarityConfig()

CirrusSearch\CirrusSearchHookRunner::onCirrusSearchSimilarityConfig

(

array &

$similarityConfig

)

Register new similarity configurations.

Parameters

array

&$similarityConfig

---

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

• includes/CirrusSearchHookRunner.php