This is the default implementation of PreferencesFactory. More...

Inheritance diagram for MediaWiki\Preferences\DefaultPreferencesFactory:

Collaboration diagram for MediaWiki\Preferences\DefaultPreferencesFactory:

[legend]

Public Member Functions
	__construct ( $options, Language $contLang, AuthManager $authManager, LinkRenderer $linkRenderer, NamespaceInfo $nsInfo=null)
	Do not call this directly. More...

	getForm (User $user, IContextSource $context, $formClass=PreferencesFormOOUI::class, array $remove=[])

	getFormDescriptor (User $user, IContextSource $context)

	getSaveBlacklist ()

Static Public Attributes
static array	$constructorOptions
	TODO Make this a const when we drop HHVM support (T192166) More...

Protected Member Functions
	applyFilters (array &$preferences, array $formDescriptor, $verb)
	Applies filters to preferences either before or after form usage. More...

	cleanSignature ( $signature, $alldata, HTMLForm $form)

	datetimePreferences ( $user, IContextSource $context, &$defaultPreferences)

	editingPreferences (User $user, MessageLocalizer $l10n, &$defaultPreferences)

	filesPreferences (IContextSource $context, &$defaultPreferences)

	generateSkinOptions (User $user, IContextSource $context)

	getDateOptions (IContextSource $context)

	getImageSizes (MessageLocalizer $l10n)

	getOptionFromUser ( $name, $info, array $userOptions)
	Pull option from a user account. More...

	getThumbSizes (MessageLocalizer $l10n)

	getTimeZoneList (Language $language)
	Get a list of all time zones. More...

	getTimezoneOptions (IContextSource $context)

	profilePreferences (User $user, IContextSource $context, &$defaultPreferences, $canIPUseHTTPS)

	rcPreferences (User $user, MessageLocalizer $l10n, &$defaultPreferences)

	renderingPreferences (User $user, MessageLocalizer $l10n, &$defaultPreferences)

	saveFormData ( $formData, HTMLForm $form, array $formDescriptor)
	Handle the form submission if everything validated properly. More...

	searchPreferences (&$defaultPreferences)

	skinPreferences (User $user, IContextSource $context, &$defaultPreferences)

	submitForm (array $formData, HTMLForm $form, array $formDescriptor)
	Save the form data and reload the page. More...

	validateSignature ( $signature, $alldata, HTMLForm $form)

	watchlistPreferences (User $user, IContextSource $context, &$defaultPreferences)

Protected Attributes
AuthManager	$authManager

Language	$contLang
	The wiki's content language. More...

LinkRenderer	$linkRenderer

NamespaceInfo	$nsInfo

ServiceOptions	$options

Private Member Functions
	loadPreferenceValues (User $user, IContextSource $context, &$defaultPreferences)
	Loads existing values for a given array of preferences. More...

Detailed Description

This is the default implementation of PreferencesFactory.

Definition at line 62 of file DefaultPreferencesFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Preferences\DefaultPreferencesFactory::__construct	(		$options,
		Language	$contLang,
		AuthManager	$authManager,
		LinkRenderer	$linkRenderer,
		NamespaceInfo	$nsInfo = `null`
	)

Do not call this directly.

Get it from MediaWikiServices.

Parameters

ServiceOptions \| Config	$options	Config accepted for backwards compatibility
Language	$contLang
AuthManager	$authManager
LinkRenderer	$linkRenderer
NamespaceInfo \| null	$nsInfo

Definition at line 122 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\$authManager, MediaWiki\Preferences\DefaultPreferencesFactory\$contLang, MediaWiki\Preferences\DefaultPreferencesFactory\$linkRenderer, MediaWiki\Preferences\DefaultPreferencesFactory\$nsInfo, MediaWiki\Preferences\DefaultPreferencesFactory\$options, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\MediaWikiServices\getInstance(), options(), and wfDeprecated().

Member Function Documentation

◆ applyFilters()

MediaWiki\Preferences\DefaultPreferencesFactory::applyFilters	(	array &	$preferences,
		array	$formDescriptor,
			$verb
	)

protected

Applies filters to preferences either before or after form usage.

Parameters

array	&$preferences
array	$formDescriptor
string	$verb	Name of the filter method to call, either 'filterFromForm' or 'filterForForm'

Definition at line 1663 of file DefaultPreferencesFactory.php.

References $filter, and as.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\loadPreferenceValues(), and MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData().

◆ cleanSignature()

MediaWiki\Preferences\DefaultPreferencesFactory::cleanSignature	(		$signature,
			$alldata,
		HTMLForm	$form
	)

protected

Parameters

string	$signature
array	$alldata
HTMLForm	$form

Returns: string

Definition at line 1467 of file DefaultPreferencesFactory.php.

References $parser, Parser\cleanSigInSig(), and MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ datetimePreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::datetimePreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 770 of file DefaultPreferencesFactory.php.

References $e, $lang, $user, class, Xml\element(), HTMLFormField\flattenOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), IContextSource\getLanguage(), MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions(), Html\hidden(), and wfTimestampNow().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ editingPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::editingPreferences	(	User	$user,
		MessageLocalizer	$l10n,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
MessageLocalizer	$l10n
array	&$defaultPreferences

Definition at line 923 of file DefaultPreferencesFactory.php.

References User\isAllowed(), MessageLocalizer\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ filesPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::filesPreferences	(	IContextSource	$context,
		&	$defaultPreferences
	)

protected

Parameters

IContextSource	$context
array	&$defaultPreferences

Definition at line 748 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\getImageSizes(), and MediaWiki\Preferences\DefaultPreferencesFactory\getThumbSizes().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ generateSkinOptions()

MediaWiki\Preferences\DefaultPreferencesFactory::generateSkinOptions	(	User	$user,
		IContextSource	$context
	)

protected

Parameters

User	$user	The User object
IContextSource	$context

Returns: array Text/links to display as key; $skinkey as value

Definition at line 1277 of file DefaultPreferencesFactory.php.

References $ret, as, Skin\getAllowedSkins(), IContextSource\getLanguage(), User\getName(), User\getOption(), IContextSource\getRequest(), Skin\getSkinNames(), Title\makeTitleSafe(), MessageLocalizer\msg(), Title\newMainPage(), NS_USER, options(), and use.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences().

◆ getDateOptions()

MediaWiki\Preferences\DefaultPreferencesFactory::getDateOptions ( IContextSource $context )

protected

Parameters

IContextSource $context

Returns: array

Definition at line 1373 of file DefaultPreferencesFactory.php.

References $lang, $ret, $wgDefaultUserOptions, as, IContextSource\getLanguage(), MessageLocalizer\msg(), and wfTimestampNow().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences().

◆ getForm()

MediaWiki\Preferences\DefaultPreferencesFactory::getForm	(	User	$user,
		IContextSource	$context,
			$formClass = `PreferencesFormOOUI::class`,
		array	$remove = `[]`
	)

Parameters

User	$user
IContextSource	$context
string	$formClass
array	$remove	Array of items to remove

Returns: HTMLForm

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 1486 of file DefaultPreferencesFactory.php.

References $formDescriptor, $name, as, MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), IContextSource\getOutput(), IContextSource\getRequest(), IContextSource\getTitle(), MessageLocalizer\msg(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and use.

◆ getFormDescriptor()

MediaWiki\Preferences\DefaultPreferencesFactory::getFormDescriptor	(	User	$user,
		IContextSource	$context
	)

Exceptions

MWException

Parameters

User	$user
IContextSource	$context

Returns: array|null

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 164 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getForm().

◆ getImageSizes()

MediaWiki\Preferences\DefaultPreferencesFactory::getImageSizes ( MessageLocalizer $l10n )

protected

Parameters

MessageLocalizer $l10n

Returns: array

Definition at line 1407 of file DefaultPreferencesFactory.php.

References $ret, as, MessageLocalizer\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\filesPreferences().

◆ getOptionFromUser()

MediaWiki\Preferences\DefaultPreferencesFactory::getOptionFromUser	(		$name,
			$info,
		array	$userOptions
	)

protected

Pull option from a user account.

Handles stuff like array-type preferences.

Parameters

string	$name
array	$info
array	$userOptions

Returns: array|string

Definition at line 250 of file DefaultPreferencesFactory.php.

References $name, $rows, $value, as, class, HTMLFormField\flattenOptions(), and null.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\loadPreferenceValues().

◆ getSaveBlacklist()

MediaWiki\Preferences\DefaultPreferencesFactory::getSaveBlacklist ( )

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 151 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\loadPreferenceValues(), and MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData().

◆ getThumbSizes()

MediaWiki\Preferences\DefaultPreferencesFactory::getThumbSizes ( MessageLocalizer $l10n )

protected

Parameters

MessageLocalizer $l10n

Returns: array

Definition at line 1424 of file DefaultPreferencesFactory.php.

References $ret, as, MessageLocalizer\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\filesPreferences().

◆ getTimeZoneList()

MediaWiki\Preferences\DefaultPreferencesFactory::getTimeZoneList ( Language $language )

protected

Get a list of all time zones.

Parameters

Language $language Language used for the localized names

Returns: array A list of all time zones. The system name of the time zone is used as key and the value is an array which contains localized name, the timecorrection value used for preferences and the region

Since: 1.26

Definition at line 1724 of file DefaultPreferencesFactory.php.

References $value, as, and wfMessage().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions().

◆ getTimezoneOptions()

MediaWiki\Preferences\DefaultPreferencesFactory::getTimezoneOptions ( IContextSource $context )

protected

Parameters

IContextSource $context

Returns: array

Definition at line 1541 of file DefaultPreferencesFactory.php.

References $opt, as, IContextSource\getLanguage(), MWTimestamp\getLocalInstance(), MediaWiki\Preferences\DefaultPreferencesFactory\getTimeZoneList(), MessageLocalizer\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences().

◆ loadPreferenceValues()

MediaWiki\Preferences\DefaultPreferencesFactory::loadPreferenceValues	(	User	$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

private

Loads existing values for a given array of preferences.

Exceptions

MWException

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences	Array to load values for

Returns: array|null

Definition at line 198 of file DefaultPreferencesFactory.php.

References $name, MediaWiki\Preferences\DefaultPreferencesFactory\applyFilters(), as, User\getDefaultOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getOptionFromUser(), User\getOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getSaveBlacklist(), User\isAllowed(), HTMLForm\loadInputFromParameters(), null, and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ profilePreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences	(	User	$user,
		IContextSource	$context,
		&	$defaultPreferences,
			$canIPUseHTTPS
	)

protected

Todo:: Inject user Language instead of using context.

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences
bool	$canIPUseHTTPS	Whether the user's IP is likely to be able to access the wiki via HTTPS.

Returns: void

Definition at line 296 of file DefaultPreferencesFactory.php.

References $code, $lang, $languages, LanguageConverter\$languagesWithVariants, $name, MediaWiki\Preferences\DefaultPreferencesFactory\$options, $t, $time, $user, as, LanguageCode\bcp47(), class, MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature(), Language\fetchLanguageNames(), User\getEditCount(), User\getEffectiveGroups(), User\getEmail(), User\getEmailAuthenticationTimestamp(), User\getGroupMemberships(), MediaWiki\MediaWikiServices\getInstance(), IContextSource\getLanguage(), UserGroupMembership\getLink(), User\getName(), IContextSource\getOutput(), User\getRealName(), User\getRegistration(), IContextSource\getTitle(), SpecialPage\getTitleFor(), IContextSource\getUser(), User\isAllowed(), MessageLocalizer\msg(), ParserOptions\newFromContext(), null, options(), string, Parser\stripOuterParagraph(), text, and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ rcPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::rcPreferences	(	User	$user,
		MessageLocalizer	$l10n,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
MessageLocalizer	$l10n
array	&$defaultPreferences

Definition at line 990 of file DefaultPreferencesFactory.php.

References class, MessageLocalizer\msg(), options(), User\useNPPatrol(), and User\useRCPatrol().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ renderingPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::renderingPreferences	(	User	$user,
		MessageLocalizer	$l10n,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
MessageLocalizer	$l10n
array	&$defaultPreferences

Definition at line 849 of file DefaultPreferencesFactory.php.

References $value, as, User\isAllowed(), MessageLocalizer\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ saveFormData()

MediaWiki\Preferences\DefaultPreferencesFactory::saveFormData	(		$formData,
		HTMLForm	$form,
		array	$formDescriptor
	)

protected

Handle the form submission if everything validated properly.

Parameters

array	$formData
HTMLForm	$form
	array[]	$formDescriptor

Returns: bool|Status|string

Definition at line 1589 of file DefaultPreferencesFactory.php.

References $user, $value, MediaWiki\Preferences\DefaultPreferencesFactory\applyFilters(), as, ContextSource\getContext(), MediaWiki\Preferences\DefaultPreferencesFactory\getSaveBlacklist(), StatusValue\newFatal(), null, options(), and Hooks\run().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

◆ searchPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::searchPreferences ( & $defaultPreferences )

protected

Parameters

array &$defaultPreferences

Definition at line 1264 of file DefaultPreferencesFactory.php.

References as.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ skinPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::skinPreferences	(	User	$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 700 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), IContextSource\getLanguage(), User\getName(), Title\makeTitleSafe(), MessageLocalizer\msg(), NS_USER, and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

◆ submitForm()

MediaWiki\Preferences\DefaultPreferencesFactory::submitForm	(	array	$formData,
		HTMLForm	$form,
		array	$formDescriptor
	)

protected

Save the form data and reload the page.

Parameters

array	$formData
HTMLForm	$form
array	$formDescriptor

Returns: Status

Definition at line 1692 of file DefaultPreferencesFactory.php.

References MediaWiki\$context, $res, ContextSource\getContext(), IContextSource\getOutput(), IContextSource\getRequest(), HTMLForm\getTitle(), StatusValue\newGood(), and MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getForm().

◆ validateSignature()

MediaWiki\Preferences\DefaultPreferencesFactory::validateSignature	(		$signature,
			$alldata,
		HTMLForm	$form
	)

protected

Parameters

string	$signature
array	$alldata
HTMLForm	$form

Returns: bool|string

Definition at line 1442 of file DefaultPreferencesFactory.php.

References Xml\element(), MediaWiki\MediaWikiServices\getInstance(), ContextSource\msg(), and options().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ watchlistPreferences()

MediaWiki\Preferences\DefaultPreferencesFactory::watchlistPreferences	(	User	$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

protected

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 1089 of file DefaultPreferencesFactory.php.

References MediaWiki\$action, as, SpecialWatchlist\checkStructuredFilterUiEnabled(), class, SpecialPage\getTitleFor(), User\isAllowed(), MessageLocalizer\msg(), options(), string, and User\useRCPatrol().

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor().

Member Data Documentation

◆ $authManager

AuthManager MediaWiki\Preferences\DefaultPreferencesFactory::$authManager

protected

Definition at line 72 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\__construct().

◆ $constructorOptions

array MediaWiki\Preferences\DefaultPreferencesFactory::$constructorOptions

static

Initial value:

= [
        'AllowUserCss',
        'AllowUserCssPrefs',
        'AllowUserJs',
        'DefaultSkin',
        'DisableLangConversion',
        'EmailAuthentication',
        'EmailConfirmToEdit',
        'EnableEmail',
        'EnableUserEmail',
        'EnableUserEmailBlacklist',
        'EnotifMinorEdits',
        'EnotifRevealEditorAddress',
        'EnotifUserTalk',
        'EnotifWatchlist',
        'HiddenPrefs',
        'ImageLimits',
        'LanguageCode',
        'LocalTZoffset',
        'MaxSigChars',
        'RCMaxAge',
        'RCShowWatchingUsers',
        'RCWatchCategoryMembership',
        'SecureLogin',
        'ThumbLimits',
    ]

TODO Make this a const when we drop HHVM support (T192166)

Since: 1.34

Definition at line 86 of file DefaultPreferencesFactory.php.

◆ $contLang

Language MediaWiki\Preferences\DefaultPreferencesFactory::$contLang

protected

The wiki's content language.

Definition at line 69 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\__construct().

◆ $linkRenderer

LinkRenderer MediaWiki\Preferences\DefaultPreferencesFactory::$linkRenderer

protected

Definition at line 75 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\__construct().

◆ $nsInfo

NamespaceInfo MediaWiki\Preferences\DefaultPreferencesFactory::$nsInfo

protected

Definition at line 78 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\__construct().

◆ $options

ServiceOptions MediaWiki\Preferences\DefaultPreferencesFactory::$options

protected

Definition at line 66 of file DefaultPreferencesFactory.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\__construct(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

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

includes/preferences/DefaultPreferencesFactory.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFilters()

◆ cleanSignature()

◆ datetimePreferences()

◆ editingPreferences()

◆ filesPreferences()

◆ generateSkinOptions()

◆ getDateOptions()

◆ getForm()

◆ getFormDescriptor()

◆ getImageSizes()

◆ getOptionFromUser()

◆ getSaveBlacklist()

◆ getThumbSizes()

◆ getTimeZoneList()

◆ getTimezoneOptions()

◆ loadPreferenceValues()

◆ profilePreferences()

◆ rcPreferences()

◆ renderingPreferences()

◆ saveFormData()

◆ searchPreferences()

◆ skinPreferences()

◆ submitForm()

◆ validateSignature()

◆ watchlistPreferences()

Member Data Documentation

◆ $authManager

◆ $constructorOptions

◆ $contLang

◆ $linkRenderer

◆ $nsInfo

◆ $options