A service class to control default user options. More...
Public Member Functions | ||||||||||||||||
| __construct (ServiceOptions $options, Language $contentLang, HookContainer $hookContainer) | ||||||||||||||||
| 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.
| ||||||||||||||||
 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. | ||||||||||||||||
Public Attributes | |
| const | CONSTRUCTOR_OPTIONS |
| 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) | |
Private Member Functions | |
| verifyUsable (UserIdentity $user, string $fname) | |
| Checks if the DefaultOptionsLookup is usable as an instance of UserOptionsLookup. | |
Private Attributes | |
| Language | $contentLang |
| array null | $defaultOptions = null |
| Cached default options. | |
| HookRunner | $hookRunner |
| ServiceOptions | $serviceOptions |
Detailed Description
A service class to control default user options.
- Since
- 1.35
Definition at line 35 of file DefaultOptionsLookup.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\User\DefaultOptionsLookup::__construct | ( | ServiceOptions | $options, |
| Language | $contentLang, | ||
| HookContainer | $hookContainer | ||
| ) |
- Parameters
-
ServiceOptions $options Language $contentLang HookContainer $hookContainer
Definition at line 63 of file DefaultOptionsLookup.php.
References MediaWiki\User\DefaultOptionsLookup\$contentLang, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().
Member Function Documentation
◆ getDefaultOptions()
| MediaWiki\User\DefaultOptionsLookup::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 77 of file DefaultOptionsLookup.php.
References MediaWiki\User\DefaultOptionsLookup\$defaultOptions.
◆ getOption()
| 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.
- 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 110 of file DefaultOptionsLookup.php.
◆ getOptions()
| MediaWiki\User\DefaultOptionsLookup::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
Reimplemented from MediaWiki\User\UserOptionsLookup.
Definition at line 124 of file DefaultOptionsLookup.php.
◆ verifyUsable()
|
private |
Checks if the DefaultOptionsLookup is usable as an instance of UserOptionsLookup.
It only makes sense in an installer context when UserOptionsManager cannot be yet instantiated as the database is not available. Thus, this can only be called for an anon user, calling under different circumstances indicates a bug.
- Parameters
-
UserIdentity $user string $fname
Definition at line 144 of file DefaultOptionsLookup.php.
References MediaWiki\User\UserIdentity\isRegistered().
Member Data Documentation
◆ $contentLang
|
private |
Definition at line 50 of file DefaultOptionsLookup.php.
Referenced by MediaWiki\User\DefaultOptionsLookup\__construct().
◆ $defaultOptions
|
private |
Cached default options.
Definition at line 53 of file DefaultOptionsLookup.php.
Referenced by MediaWiki\User\DefaultOptionsLookup\getDefaultOptions().
◆ $hookRunner
|
private |
Definition at line 56 of file DefaultOptionsLookup.php.
◆ $serviceOptions
|
private |
Definition at line 47 of file DefaultOptionsLookup.php.
◆ CONSTRUCTOR_OPTIONS
| const MediaWiki\User\DefaultOptionsLookup::CONSTRUCTOR_OPTIONS |
- Access: internal
- For use by ServiceWiring
Definition at line 40 of file DefaultOptionsLookup.php.
The documentation for this class was generated from the following file:
- includes/user/DefaultOptionsLookup.php
