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 (ServiceOptions $options, Language $contLang, AuthManager $authManager, LinkRenderer $linkRenderer, NamespaceInfo $nsInfo, PermissionManager $permissionManager, ILanguageConverter $languageConverter=null, LanguageNameUtils $languageNameUtils=null, HookContainer $hookContainer=null)

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

	getFormDescriptor (User $user, IContextSource $context)

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

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)

	getDateOptions (IContextSource $context)

	getImageSizes (MessageLocalizer $l10n)

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

	getThumbSizes (MessageLocalizer $l10n)

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

	getTimezoneOptions (IContextSource $context)

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

	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 (&$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

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

Private Attributes
HookRunner	$hookRunner

ILanguageConverter	$languageConverter

Detailed Description

This is the default implementation of PreferencesFactory.

Definition at line 65 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 = `null`,
		LanguageNameUtils	$languageNameUtils = `null`,
		HookContainer	$hookContainer = `null`
	)

Parameters

ServiceOptions	$options
Language	$contLang
AuthManager	$authManager
LinkRenderer	$linkRenderer
NamespaceInfo	$nsInfo
PermissionManager	$permissionManager
ILanguageConverter \| null	$languageConverter
LanguageNameUtils \| null	$languageNameUtils
HookContainer \| null	$hookContainer

Definition at line 142 of file DefaultPreferencesFactory.php.

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

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

References MediaWiki\MediaWikiServices\getInstance().

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

References $lang, Xml\element(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), IContextSource\getLanguage(), User\getOption(), MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions(), 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 1042 of file DefaultPreferencesFactory.php.

References 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 867 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
IContextSource	$context

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

Definition at line 1406 of file DefaultPreferencesFactory.php.

References IContextSource\getLanguage(), User\getName(), User\getOption(), IContextSource\getRequest(), 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 1503 of file DefaultPreferencesFactory.php.

References $lang, $wgDefaultUserOptions, 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 1655 of file DefaultPreferencesFactory.php.

References MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), IContextSource\getOutput(), IContextSource\getRequest(), IContextSource\getTitle(), MessageLocalizer\msg(), and MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

◆ 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 199 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 1537 of file DefaultPreferencesFactory.php.

References MessageLocalizer\msg().

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

References MediaWiki\Preferences\DefaultPreferencesFactory\$options.

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

◆ 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 186 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 1554 of file DefaultPreferencesFactory.php.

References MessageLocalizer\msg().

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