CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\Profile\ConfigSearchProfileOverride Class Reference

Overrider that gets its name using an entry in a Config object. More...

+ Inheritance diagram for CirrusSearch\Profile\ConfigSearchProfileOverride:
+ Collaboration diagram for CirrusSearch\Profile\ConfigSearchProfileOverride:

Public Member Functions

 __construct (\Config $config, $configEntry, $priority=SearchProfileOverride::CONFIG_PRIO)
 
 getOverriddenName (array $contextParams)
 Get the overridden name or null if it cannot be overridden.
 
 priority ()
 The priority of this override, lower wins.
 
 explain ()
 

Additional Inherited Members

- Public Attributes inherited from CirrusSearch\Profile\SearchProfileOverride
const URI_PARAM_PRIO = 100
 Default priority for uri param overrides.
 
const USER_PREF_PRIO = 200
 Default priority for user pref overrides.
 
const CONTEXTUAL_PRIO = 300
 Default priority for contextual overrides.
 
const CONFIG_PRIO = 400
 Default priority for config overrides.
 

Detailed Description

Overrider that gets its name using an entry in a Config object.

Constructor & Destructor Documentation

◆ __construct()

CirrusSearch\Profile\ConfigSearchProfileOverride::__construct ( \Config $config,
$configEntry,
$priority = SearchProfileOverride::CONFIG_PRIO )
Parameters
\Config$config
string$configEntrythe name of the config entry holding the name of the overridden profile
int$priority

Member Function Documentation

◆ explain()

CirrusSearch\Profile\ConfigSearchProfileOverride::explain ( )

◆ getOverriddenName()

CirrusSearch\Profile\ConfigSearchProfileOverride::getOverriddenName ( array $contextParams)

Get the overridden name or null if it cannot be overridden.

Parameters
string[]$contextParams
Returns
string|null

Implements CirrusSearch\Profile\SearchProfileOverride.

◆ priority()

CirrusSearch\Profile\ConfigSearchProfileOverride::priority ( )

The priority of this override, lower wins.

Returns
int

Implements CirrusSearch\Profile\SearchProfileOverride.


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