CirrusSearch\Profile\UserPrefSearchProfileOverride Class Reference

Overrider based on user preference. More...

Inheritance diagram for CirrusSearch\Profile\UserPrefSearchProfileOverride:

Collaboration diagram for CirrusSearch\Profile\UserPrefSearchProfileOverride:

Public Member Functions
	__construct (UserIdentity $user, UserOptionsLookup $userOptionsLookup, $preference, $priority=SearchProfileOverride::USER_PREF_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 based on user preference.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Profile\UserPrefSearchProfileOverride::__construct	(	UserIdentity	$user,
		UserOptionsLookup	$userOptionsLookup,
			$preference,
			$priority = SearchProfileOverride::USER_PREF_PRIO )

Parameters

UserIdentity	$user
UserOptionsLookup	$userOptionsLookup
string	$preference
int	$priority

Member Function Documentation

explain()

CirrusSearch\Profile\UserPrefSearchProfileOverride::explain

(

)

Returns

array

Implements CirrusSearch\Profile\SearchProfileOverride.

getOverriddenName()

CirrusSearch\Profile\UserPrefSearchProfileOverride::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\UserPrefSearchProfileOverride::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:

• includes/Profile/UserPrefSearchProfileOverride.php