MediaWiki
master
|
A service class to control default user options. More...
Public Member Functions | ||||||||||||||||
__construct (ServiceOptions $options, Language $contentLang, HookContainer $hookContainer, NamespaceInfo $nsInfo, bool $isDatabaselessTest) | ||||||||||||||||
getDefaultOptions () | ||||||||||||||||
Combine the language default options with any site-specific options and add the default language variants.
| ||||||||||||||||
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.
| ||||||||||||||||
getOptions (UserIdentity $user, int $flags=0, int $queryFlags=self::READ_NORMAL) | ||||||||||||||||
Get all user's options.
| ||||||||||||||||
![]() | ||||||||||||||||
getBoolOption (UserIdentity $user, string $oname, int $queryFlags=self::READ_NORMAL) | ||||||||||||||||
Get the user's current setting for a given option, as a boolean value. More... | ||||||||||||||||
getDefaultOption (string $opt) | ||||||||||||||||
Get a given default option value. More... | ||||||||||||||||
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. More... | ||||||||||||||||
Public Attributes | |
const | CONSTRUCTOR_OPTIONS |
![]() | |
const | EXCLUDE_DEFAULTS = 1 |
Exclude user options that are set to their default value. More... | |
![]() | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) More... | |
A service class to control default user options.
Definition at line 37 of file DefaultOptionsLookup.php.
MediaWiki\User\DefaultOptionsLookup::__construct | ( | ServiceOptions | $options, |
Language | $contentLang, | ||
HookContainer | $hookContainer, | ||
NamespaceInfo | $nsInfo, | ||
bool | $isDatabaselessTest | ||
) |
ServiceOptions | $options | |
Language | $contentLang | |
HookContainer | $hookContainer | |
NamespaceInfo | $nsInfo | |
bool | $isDatabaselessTest |
Definition at line 69 of file DefaultOptionsLookup.php.
References MediaWiki\Config\ServiceOptions\assertRequiredOptions().
MediaWiki\User\DefaultOptionsLookup::getDefaultOptions | ( | ) |
Combine the language default options with any site-specific options and add the default language variants.
Reimplemented from MediaWiki\User\UserOptionsLookup.
Definition at line 87 of file DefaultOptionsLookup.php.
MediaWiki\User\DefaultOptionsLookup::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.
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 |
Reimplemented from MediaWiki\User\UserOptionsLookup.
Definition at line 125 of file DefaultOptionsLookup.php.
MediaWiki\User\DefaultOptionsLookup::getOptions | ( | UserIdentity | $user, |
int | $flags = 0 , |
||
int | $queryFlags = self::READ_NORMAL |
||
) |
Get all user's options.
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 |
Reimplemented from MediaWiki\User\UserOptionsLookup.
Definition at line 139 of file DefaultOptionsLookup.php.
const MediaWiki\User\DefaultOptionsLookup::CONSTRUCTOR_OPTIONS |
Definition at line 42 of file DefaultOptionsLookup.php.