A UserOptionsLookup that's just an array. More...

Inheritance diagram for MediaWiki\User\StaticUserOptionsLookup:

[legend]

Collaboration diagram for MediaWiki\User\StaticUserOptionsLookup:

[legend]

Public Member Functions

__construct (array $userMap, array $defaults=[])

getDefaultOptions ()

Combine the language default options with any site-specific options and add the default language variants.

Returns: array

getOption (UserIdentity $user, string $oname, $defaultOverride=null, bool $ignoreHidden=false, int $queryFlags=self::READ_NORMAL)

Get the user's current setting for a given option.

Parameters

UserIdentity	$user	The user to get the option for
string	$oname	The option to check
mixed \| null	$defaultOverride	A default value returned if the option does not exist
bool	$ignoreHidden	Whether to ignore the effects of $wgHiddenPrefs
int	$queryFlags	A bit field composed of READ_XXX flags

Returns: mixed|null User's current value for the option

See also: getBoolOption(); getIntOption()

getOptions (UserIdentity $user, int $flags=0, int $queryFlags=self::READ_NORMAL)

Get all user's options.

Parameters

UserIdentity	$user	The user to get the option for
int	$flags	Bitwise combination of: UserOptionsManager::EXCLUDE_DEFAULTS Exclude user options that are set to the default value.
int	$queryFlags	A bit field composed of READ_XXX flags

Returns: array

Public Member Functions inherited from MediaWiki\User\UserOptionsLookup

getBoolOption (UserIdentity $user, string $oname, int $queryFlags=self::READ_NORMAL)

Get the user's current setting for a given option, as a boolean value.

getDefaultOption (string $opt)

Get a given default option value.

getIntOption (UserIdentity $user, string $oname, int $defaultOverride=0, int $queryFlags=self::READ_NORMAL)

Get the user's current setting for a given option, as an integer value.

Private Attributes
mixed[]	$defaults

array[]	$userMap

Additional Inherited Members
Public Attributes inherited from MediaWiki\User\UserOptionsLookup
const	EXCLUDE_DEFAULTS = 1
	Exclude user options that are set to their default value.

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS)

Detailed Description

A UserOptionsLookup that's just an array.

Useful for testing and creating staging environments. Note that unlike UserOptionsManager, no attempt is made to canonincalize user names.

Since: 1.36

Definition at line 10 of file StaticUserOptionsLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\StaticUserOptionsLookup::__construct	(	array	$userMap,
		array	$defaults = `[]`
	)

Parameters

array[]	$userMap	User options, username => [ option name => value ]
mixed[]	$defaults	Defaults for each option, option name => value

Definition at line 22 of file StaticUserOptionsLookup.php.

References MediaWiki\User\StaticUserOptionsLookup\$defaults, and MediaWiki\User\StaticUserOptionsLookup\$userMap.

Member Function Documentation

◆ getDefaultOptions()

MediaWiki\User\StaticUserOptionsLookup::getDefaultOptions ( )

Combine the language default options with any site-specific options and add the default language variants.

Returns: array

Reimplemented from MediaWiki\User\UserOptionsLookup.

Definition at line 28 of file StaticUserOptionsLookup.php.

◆ getOption()

MediaWiki\User\StaticUserOptionsLookup::getOption	(	UserIdentity	$user,
		string	$oname,
			$defaultOverride = `null`,
		bool	$ignoreHidden = `false`,
		int	$queryFlags = `self::READ_NORMAL`
	)

Get the user's current setting for a given option.

Parameters

UserIdentity	$user	The user to get the option for
string	$oname	The option to check
mixed \| null	$defaultOverride	A default value returned if the option does not exist
bool	$ignoreHidden	Whether to ignore the effects of $wgHiddenPrefs
int	$queryFlags	A bit field composed of READ_XXX flags

Returns: mixed|null User's current value for the option

See also: getBoolOption(); getIntOption()

Reimplemented from MediaWiki\User\UserOptionsLookup.

Definition at line 33 of file StaticUserOptionsLookup.php.

◆ getOptions()

MediaWiki\User\StaticUserOptionsLookup::getOptions	(	UserIdentity	$user,
		int	$flags = `0`,
		int	$queryFlags = `self::READ_NORMAL`
	)

Get all user's options.

Parameters

UserIdentity	$user	The user to get the option for
int	$flags	Bitwise combination of: UserOptionsManager::EXCLUDE_DEFAULTS Exclude user options that are set to the default value.
int	$queryFlags	A bit field composed of READ_XXX flags