CirrusSearch\Maintenance\GlobalCustomFilter Class Reference

Public Member Functions
	__construct (string $type='filter')
	setRequiredPlugins (array $requiredPlugins)
	setMustFollowFilters (array $mustFollowFilters)
	setDenyList (array $denyList)
	setApplyToAnalyzers (array $applyToAnalyzers)
	getApplyToAnalyzers ()
	filterIsUsable (string $language, array $installedPlugins)
	check to see if the filter is compatible with a given language and set of installed plugins

Static Public Member Functions
static	insertGlobalCustomFilter (array $config, string $analyzer, string $filterName, GlobalCustomFilter $filterInfo)
	insert one of the global custom filters into the right spot in the analysis chain

Member Function Documentation

filterIsUsable()

CirrusSearch\Maintenance\GlobalCustomFilter::filterIsUsable	(	string	$language,
		array	$installedPlugins )

check to see if the filter is compatible with a given language and set of installed plugins

Parameters

string	$language
string[]	$installedPlugins

Returns

bool

insertGlobalCustomFilter()

static CirrusSearch\Maintenance\GlobalCustomFilter::insertGlobalCustomFilter ( array $config, string $analyzer, string $filterName, GlobalCustomFilter $filterInfo )

static

insert one of the global custom filters into the right spot in the analysis chain

Parameters

mixed[]	$config	the analysis config we are modifying
string	$analyzer	the specifc analyzer we are modifying
string	$filterName	filter to add
GlobalCustomFilter	$filterInfo	includes filter type & incompatible filters

Returns

mixed[] updated config

setApplyToAnalyzers()

CirrusSearch\Maintenance\GlobalCustomFilter::setApplyToAnalyzers

(

array

$applyToAnalyzers

)

Parameters

string[]

$applyToAnalyzers

Returns

self

setDenyList()

CirrusSearch\Maintenance\GlobalCustomFilter::setDenyList

(

array

$denyList

)

Parameters

string[]

$denyList

Returns

self

setMustFollowFilters()

CirrusSearch\Maintenance\GlobalCustomFilter::setMustFollowFilters

(

array

$mustFollowFilters

)

Parameters

string[]

$mustFollowFilters

Returns

self

setRequiredPlugins()

CirrusSearch\Maintenance\GlobalCustomFilter::setRequiredPlugins

(

array

$requiredPlugins

)

Parameters

string[]

$requiredPlugins

Returns

self

---

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

• includes/Maintenance/GlobalCustomFilter.php