CirrusSearch\Wikimedia\WeightedTagsHooks Class Reference

Inheritance diagram for CirrusSearch\Wikimedia\WeightedTagsHooks:

Collaboration diagram for CirrusSearch\Wikimedia\WeightedTagsHooks:

Public Member Functions
	onSearchIndexFields (&$fields, $engine)
	Define mapping for the weighted_tags field.

Static Public Member Functions
static	onCirrusSearchSimilarityConfig (array &$similarity)
	Configure the similarity needed for the article topics field.
static	configureWeightedTagsSimilarity (array &$similarity, Config $config)
	Visible for testing.
static	configureWeightedTagsFieldMapping (array &$fields, Config $config)
	Visible for testing.
static	onCirrusSearchAnalysisConfig (array &$config, AnalysisConfigBuilder $analysisConfigBuilder)
	Configure default analyzer for the weighted_tags field.
static	onCirrusSearchAddQueryFeatures (SearchConfig $config, array &$extraFeatures)
	Make weighted_tags search features available.
static	configureWeightedTagsFieldAnalysis (array &$analysisConfig, Config $config)
	Visible only for testing.

Public Attributes
const	FIELD_NAME = 'weighted_tags'
const	FIELD_SIMILARITY = 'weighted_tags_similarity'
const	FIELD_INDEX_ANALYZER = 'weighted_tags'
const	FIELD_SEARCH_ANALYZER = 'keyword'
const	WMF_EXTRA_FEATURES = 'CirrusSearchWMFExtraFeatures'
const	CONFIG_OPTIONS = 'weighted_tags'
const	BUILD_OPTION = 'build'
const	USE_OPTION = 'use'
const	MAX_SCORE_OPTION = 'max_score'

Member Function Documentation

configureWeightedTagsFieldAnalysis()

static CirrusSearch\Wikimedia\WeightedTagsHooks::configureWeightedTagsFieldAnalysis ( array & $analysisConfig, Config $config )

static

Visible only for testing.

Parameters

array	&$analysisConfig	panalysis settings to update
Config	$config	the wiki configuration

configureWeightedTagsFieldMapping()

static CirrusSearch\Wikimedia\WeightedTagsHooks::configureWeightedTagsFieldMapping ( array & $fields, Config $config )

static

Visible for testing.

Parameters

\SearchIndexField[]	&$fields	array of field definitions to update
Config	$config	the wiki configuration

configureWeightedTagsSimilarity()

static CirrusSearch\Wikimedia\WeightedTagsHooks::configureWeightedTagsSimilarity ( array & $similarity, Config $config )

static

Visible for testing.

Parameters

array	&$similarity	similarity settings to update
Config	$config	current configuration

onCirrusSearchAddQueryFeatures()

static CirrusSearch\Wikimedia\WeightedTagsHooks::onCirrusSearchAddQueryFeatures ( SearchConfig $config, array & $extraFeatures )

static

Make weighted_tags search features available.

Parameters

SearchConfig	$config
array	&$extraFeatures	Array holding KeywordFeature objects

See also

ArticleTopicFeature

onCirrusSearchAnalysisConfig()

static CirrusSearch\Wikimedia\WeightedTagsHooks::onCirrusSearchAnalysisConfig ( array & $config, AnalysisConfigBuilder $analysisConfigBuilder )

static

Configure default analyzer for the weighted_tags field.

Parameters

array	&$config	analysis settings to update
AnalysisConfigBuilder	$analysisConfigBuilder	unneeded

See also

https://www.mediawiki.org/wiki/Extension:CirrusSearch/Hooks/CirrusSearchAnalysisConfig

onCirrusSearchSimilarityConfig()

static CirrusSearch\Wikimedia\WeightedTagsHooks::onCirrusSearchSimilarityConfig ( array & $similarity )

static

Configure the similarity needed for the article topics field.

Parameters

array

&$similarity

similarity settings to update

See also

https://www.mediawiki.org/wiki/Extension:CirrusSearch/Hooks/CirrusSearchSimilarityConfig

onSearchIndexFields()

CirrusSearch\Wikimedia\WeightedTagsHooks::onSearchIndexFields	(	&	$fields,
			$engine )

Define mapping for the weighted_tags field.

Parameters

array	&$fields	array of field definitions to update
SearchEngine	$engine	the search engine requesting field definitions

See also

https://www.mediawiki.org/wiki/Manual:Hooks/SearchIndexFields

---

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

• includes/Wikimedia/WeightedTagsHooks.php