MediaWiki master
Public Member Functions | Public Attributes | List of all members
MediaWiki\User\Options\ConditionalDefaultsLookup Class Reference

Public Member Functions

 __construct (ServiceOptions $options, UserRegistrationLookup $userRegistrationLookup, UserIdentityUtils $userIdentityUtils)
 
 getConditionallyDefaultOptions ()
 Get all conditionally default user options.
 
 getOptionDefaultForUser (string $optionName, UserIdentity $userIdentity)
 Get the conditional default for user and option.
 
 hasConditionalDefault (string $option)
 Does the option support conditional defaults?
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

Definition at line 13 of file ConditionalDefaultsLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\Options\ConditionalDefaultsLookup::__construct ( ServiceOptions $options,
UserRegistrationLookup $userRegistrationLookup,
UserIdentityUtils $userIdentityUtils )

Definition at line 26 of file ConditionalDefaultsLookup.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getConditionallyDefaultOptions()

MediaWiki\User\Options\ConditionalDefaultsLookup::getConditionallyDefaultOptions ( )

Get all conditionally default user options.

Returns
string[]

Definition at line 56 of file ConditionalDefaultsLookup.php.

◆ getOptionDefaultForUser()

MediaWiki\User\Options\ConditionalDefaultsLookup::getOptionDefaultForUser ( string $optionName,
UserIdentity $userIdentity )

Get the conditional default for user and option.

Parameters
string$optionName
UserIdentity$userIdentity
Returns
mixed|null The default value if set, or null if it cannot be determined conditionally (default from DefaultOptionsLookup should be used in that case).

Definition at line 70 of file ConditionalDefaultsLookup.php.

◆ hasConditionalDefault()

MediaWiki\User\Options\ConditionalDefaultsLookup::hasConditionalDefault ( string $option)

Does the option support conditional defaults?

Parameters
string$option
Returns
bool

Definition at line 44 of file ConditionalDefaultsLookup.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\Options\ConditionalDefaultsLookup::CONSTRUCTOR_OPTIONS
Initial value:
= [
MainConfigNames::ConditionalUserOptions,
]
MediaWiki\MainConfigNames\ConditionalUserOptions
const ConditionalUserOptions
Name constant for the ConditionalUserOptions setting, for use with Config::get()
Definition MainConfigNames.php:2637
Access: internal
Exposed for ServiceWiring only

Definition at line 18 of file ConditionalDefaultsLookup.php.

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