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

Inherits MediaWiki\Preferences\PreferencesFactory.

Collaboration diagram for MediaWiki\Preferences\DefaultPreferencesFactory:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, Language $contLang, AuthManager $authManager, LinkRenderer $linkRenderer, NamespaceInfo $nsInfo, PermissionManager $permissionManager, ILanguageConverter $languageConverter, LanguageNameUtils $languageNameUtils, HookContainer $hookContainer, UserOptionsLookup $userOptionsLookup, ?LanguageConverterFactory $languageConverterFactory=null, ?ParserFactory $parserFactory=null, ?SkinFactory $skinFactory=null, ?UserGroupManager $userGroupManager=null, ?SignatureValidatorFactory $signatureValidatorFactory=null)

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

	getFormDescriptor (User $user, IContextSource $context)

	getOptionNamesForReset (User $user, IContextSource $context, $kinds)

	getResetKinds (User $user, IContextSource $context, $options=null)

	getSaveBlacklist ()
	Get the names of preferences that should never be saved (such as 'realname' and 'emailaddress'). Returns string[]

	listResetKinds ()
	Return a list of the types of user options currently returned by getResetKinds().

Static Public Member Functions
static	getNormalizedThumbSizes (array $limits, array $defaultUserOptions)
	Normalizes thumbnail options (which can support more than 3 values) to min, default and max values for correspondance with user preferences options available to the user (small, regular, large).

static	getPreferenceForField ( $name, HTMLFormField $field, array $userOptions)
	Get preference values for the 'default' param of html form descriptor, compatible with nested fields.

static	simplifyFormDescriptor (array $descriptor)
	Simplify form descriptor for validation or something similar.

Public Attributes
const	CONSTRUCTOR_OPTIONS

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

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

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

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

	filesPreferences (IContextSource $context, &$defaultPreferences)

	generateSkinOptions (User $user, IContextSource $context, array $validSkinNames)

	getDateOptions (IContextSource $context)

	getImageSizes (MessageLocalizer $l10n)

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

	getThumbSizes (MessageLocalizer $l10n)

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

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

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

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

	searchPreferences ( $context, &$defaultPreferences)

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

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

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

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

Protected Attributes
AuthManager	$authManager

Language	$contLang
	The wiki's content language.

LanguageNameUtils	$languageNameUtils

LinkRenderer	$linkRenderer

NamespaceInfo	$nsInfo

ServiceOptions	$options

PermissionManager	$permissionManager

UserOptionsManager	$userOptionsManager

Detailed Description

This is the default implementation of PreferencesFactory.

Definition at line 67 of file DefaultPreferencesFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Preferences\DefaultPreferencesFactory::__construct	(	ServiceOptions	$options,
		Language	$contLang,
		AuthManager	$authManager,
		LinkRenderer	$linkRenderer,
		NamespaceInfo	$nsInfo,
		PermissionManager	$permissionManager,
		ILanguageConverter	$languageConverter,
		LanguageNameUtils	$languageNameUtils,
		HookContainer	$hookContainer,
		UserOptionsLookup	$userOptionsLookup,
		?LanguageConverterFactory	$languageConverterFactory = null,
		?ParserFactory	$parserFactory = null,
		?SkinFactory	$skinFactory = null,
		?UserGroupManager	$userGroupManager = null,
		?SignatureValidatorFactory	$signatureValidatorFactory = null )

Parameters

ServiceOptions	$options
Language	$contLang
AuthManager	$authManager
LinkRenderer	$linkRenderer
NamespaceInfo	$nsInfo
PermissionManager	$permissionManager
ILanguageConverter	$languageConverter
LanguageNameUtils	$languageNameUtils
HookContainer	$hookContainer
UserOptionsLookup	$userOptionsLookup	Should be an instance of UserOptionsManager
LanguageConverterFactory \| null	$languageConverterFactory
ParserFactory \| null	$parserFactory
SkinFactory \| null	$skinFactory
UserGroupManager \| null	$userGroupManager
SignatureValidatorFactory \| null	$signatureValidatorFactory

Definition at line 169 of file DefaultPreferencesFactory.php.

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

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 2168 of file DefaultPreferencesFactory.php.

◆ cleanSignature()

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

protected

Parameters

string	$signature
array	$alldata
HTMLForm	$form

Returns: string

Definition at line 2011 of file DefaultPreferencesFactory.php.

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

◆ datetimePreferences()

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

protected

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 1055 of file DefaultPreferencesFactory.php.

References MediaWiki\Html\element(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\MainConfigNames\LocalTZoffset, 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 1185 of file DefaultPreferencesFactory.php.

References MediaWiki\MainConfigNames\AllowUserCssPrefs, MediaWiki\MainConfigNames\EnableEditRecovery, MediaWiki\User\User\isAllowed(), and MediaWiki\Language\MessageLocalizer\msg().

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

◆ filesPreferences()

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

protected

Parameters

IContextSource	$context
array	&$defaultPreferences

Definition at line 1015 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\getImageSizes(), MediaWiki\Preferences\DefaultPreferencesFactory\getNormalizedThumbSizes(), MediaWiki\Preferences\DefaultPreferencesFactory\getThumbSizes(), MediaWiki\Context\IContextSource\getUser(), MediaWiki\Language\MessageLocalizer\msg(), and MediaWiki\MainConfigNames\ThumbLimits.

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

◆ generateSkinOptions()

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

protected

Parameters

User	$user
IContextSource	$context
array	$validSkinNames

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

Definition at line 1791 of file DefaultPreferencesFactory.php.

References MediaWiki\MainConfigNames\AllowUserCss, MediaWiki\MainConfigNames\AllowUserJs, MediaWiki\MainConfigNames\DefaultSkin, MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\User\User\getName(), MediaWiki\Language\MessageLocalizer\msg(), and NS_USER.

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

◆ getDateOptions()

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

protected

Parameters

IContextSource $context

Returns: array

Definition at line 1855 of file DefaultPreferencesFactory.php.

References $wgDefaultUserOptions, MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\Language\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
	class-string<PreferencesFormOOUI>	$formClass
array	$remove	Array of items to remove

Returns: HTMLForm

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 2029 of file DefaultPreferencesFactory.php.

References MediaWiki\Context\IContextSource\getOutput(), MediaWiki\Context\IContextSource\getRequest(), MediaWiki\Context\IContextSource\getTitle(), and MediaWiki\User\User\isAllowed().

◆ getFormDescriptor()

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

Parameters

User	$user
IContextSource	$context

Returns: array

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 237 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\editingPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\filesPreferences(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\Context\IContextSource\getSkin(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\rcPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\renderingPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\searchPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ getImageSizes()

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

protected

Parameters

MessageLocalizer $l10n

Returns: array

Definition at line 1889 of file DefaultPreferencesFactory.php.

References MediaWiki\MainConfigNames\ImageLimits, and MediaWiki\Language\MessageLocalizer\msg().

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

◆ getNormalizedThumbSizes()

static MediaWiki\Preferences\DefaultPreferencesFactory::getNormalizedThumbSizes	(	array	$limits,
		array	$defaultUserOptions )

static

Normalizes thumbnail options (which can support more than 3 values) to min, default and max values for correspondance with user preferences options available to the user (small, regular, large).

Note, for now, this requires that the small size is at least 180px to smoothness the transition to three thumbnail sizes. Numbers below 180px are historical artifacts and we do not want users on Wikimedia sites to ever receive thumbnails that small. This is temporary until migrations on Wikimedia sites have occurred and must be removed before the 1.48 release so third parties are not impacted by the change and can make their own decisions.

Access: internal: only for use outside this class by ResourceLoader/SkinModule

Parameters

array	$limits	as defined in $wgThumbLimits
array	$defaultUserOptions

Returns: array of three thumbnail sizes representing small, medium, large

Definition at line 1917 of file DefaultPreferencesFactory.php.

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.

Deprecated: since 1.41; Use getPreferenceForField() instead.

Parameters

string	$name
array	$info
array	$userOptions

Returns: array|string

Definition at line 395 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\$options.

◆ getOptionNamesForReset()

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

Parameters

User	$user
IContextSource	$context
string \| string[]	$kinds

Returns: string[]

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 2324 of file DefaultPreferencesFactory.php.

◆ getPreferenceForField()

static MediaWiki\Preferences\DefaultPreferencesFactory::getPreferenceForField	(		$name,
		HTMLFormField	$field,
		array	$userOptions )

static

Get preference values for the 'default' param of html form descriptor, compatible with nested fields.

Since: 1.41

Parameters

string	$name
HTMLFormField	$field
array	$userOptions

Returns: array|string

Definition at line 368 of file DefaultPreferencesFactory.php.

◆ getResetKinds()

MediaWiki\Preferences\DefaultPreferencesFactory::getResetKinds	(	User	$user,
		IContextSource	$context,
			$options = null )

Parameters

User	$user
IContextSource	$context
array \| null	$options

Returns: string[]

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 2229 of file DefaultPreferencesFactory.php.

◆ getSaveBlacklist()

MediaWiki\Preferences\DefaultPreferencesFactory::getSaveBlacklist ( )

Get the names of preferences that should never be saved (such as 'realname' and 'emailaddress').

Returns: string[]

Implements MediaWiki\Preferences\PreferencesFactory.

Definition at line 225 of file DefaultPreferencesFactory.php.

◆ getThumbSizes()

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

protected

Parameters

MessageLocalizer $l10n

Returns: array

Definition at line 1929 of file DefaultPreferencesFactory.php.

References MediaWiki\Language\MessageLocalizer\msg(), and MediaWiki\MainConfigNames\ThumbLimits.

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

◆ listResetKinds()

MediaWiki\Preferences\DefaultPreferencesFactory::listResetKinds ( )

Return a list of the types of user options currently returned by getResetKinds().

Currently, the option kinds are:

'registered' - preferences which are registered in core MediaWiki or by extensions using the UserGetDefaultOptions hook.
'registered-multiselect' - as above, using the 'multiselect' type.
'registered-checkmatrix' - as above, using the 'checkmatrix' type.
'userjs' - preferences with names starting with 'userjs-', intended to be used by user scripts.
'special' - "preferences" that are not accessible via UserOptionsLookup::getOptions or UserOptionsManager::setOptions.
'unused' - preferences about which MediaWiki doesn't know anything. These are usually legacy options, removed in newer versions.

The API (and possibly others) use this function to determine the possible option types for validation purposes, so make sure to update this when a new option kind is added.