class UserPreferencesHandler (View source)

Properties

string $storageType

Methods

__construct(Config $config, DatabaseInterface $dbi, UserPreferences $userPreferences, LanguageManager $languageManager, ThemeManager $themeManager)

No description

void
loadUserPreferences(bool $isMinimumCommon = false)

Loads user preferences and merges them with current config must be called after control connection has been established

void
getLoginCookieValidityFromCache(int $server)

Get LoginCookieValidity from preferences cache.

Message
setUserValue(string|null $cookieName, string $cfgPath, mixed $newCfgValue, string|null $defaultValue = null)

Sets config value which is stored in user preferences (if available) or in a cookie.

mixed
getUserValue(string $cookieName, mixed $cfgValue)

Reads value stored by setUserValue()

Details

__construct(Config $config, DatabaseInterface $dbi, UserPreferences $userPreferences, LanguageManager $languageManager, ThemeManager $themeManager)

No description

Parameters

Config $config
DatabaseInterface $dbi
UserPreferences $userPreferences
LanguageManager $languageManager
ThemeManager $themeManager

void loadUserPreferences(bool $isMinimumCommon = false)

Loads user preferences and merges them with current config must be called after control connection has been established

Parameters

bool $isMinimumCommon

Return Value

void

void getLoginCookieValidityFromCache(int $server)

Get LoginCookieValidity from preferences cache.

No generic solution for loading preferences from cache as some settings need to be kept for processing in loadUserPreferences().

Parameters

int $server

Return Value

void

Message setUserValue(string|null $cookieName, string $cfgPath, mixed $newCfgValue, string|null $defaultValue = null)

Sets config value which is stored in user preferences (if available) or in a cookie.

If user preferences are not yet initialized, option is applied to global config and added to a update queue, which is processed by loadUserPreferences()

Parameters

string|null $cookieName

can be null

string $cfgPath

configuration path

mixed $newCfgValue

new value

string|null $defaultValue

default value

Return Value

Message

mixed getUserValue(string $cookieName, mixed $cfgValue)

Reads value stored by setUserValue()

Parameters

string $cookieName

cookie name

mixed $cfgValue

config value

Return Value

mixed