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)

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

Static Public Member Functions
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 74 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 176 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 2031 of file DefaultPreferencesFactory.php.

Referenced by 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 1880 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 1041 of file DefaultPreferencesFactory.php.

References MediaWiki\Html\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 1171 of file DefaultPreferencesFactory.php.

References MediaWiki\MainConfigNames\AllowUserCssPrefs, MediaWiki\MainConfigNames\EnableEditRecovery, MediaWiki\User\User\isAllowed(), and 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 1020 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,
		array	$validSkinNames )

protected

Parameters

User	$user
IContextSource	$context
array	$validSkinNames

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

Definition at line 1683 of file DefaultPreferencesFactory.php.

References MediaWiki\MainConfigNames\AllowUserCss, MediaWiki\MainConfigNames\AllowUserJs, MediaWiki\MainConfigNames\DefaultSkin, MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\User\User\getName(), 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 1747 of file DefaultPreferencesFactory.php.

References $wgDefaultUserOptions, MediaWiki\Context\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 = [] )