Override the default profile. More...

Inheritance diagram for CirrusSearch\Profile\SearchProfileOverride:

Public Member Functions
	getOverriddenName (array $contextParams)
	Get the overridden name or null if it cannot be overridden.

	priority ()
	The priority of this override, lower wins.

	explain ()
	Returns some explanation of the features stored in this overrider.

Public Attributes
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

Override the default profile.

Member Function Documentation

CirrusSearch\Profile\SearchProfileOverride::explain ( )

Returns some explanation of the features stored in this overrider.

Returns: array the explanation (must only contains primitives types arrays/numbers/strings so that it's easily serializable)

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

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

Parameters

string[] $contextParams Arbitrary parameters describing the context provided by the profile requestor.

CirrusSearch\Profile\SearchProfileOverride::priority ( )

The priority of this override, lower wins.

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