|
MediaWiki master
|
This is the default implementation of PreferencesFactory. More...
Inherits MediaWiki\Preferences\PreferencesFactory.

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').
| |
| 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 |
This is the default implementation of PreferencesFactory.
Definition at line 67 of file DefaultPreferencesFactory.php.
| 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 ) |
| 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 $authManager, $contLang, $languageNameUtils, $linkRenderer, $nsInfo, $options, $permissionManager, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and MediaWiki\MediaWikiServices\getInstance().
|
protected |
Applies filters to preferences either before or after form usage.
| array | &$preferences | |
| array | $formDescriptor | |
| string | $verb | Name of the filter method to call, either 'filterFromForm' or 'filterForForm' |
Definition at line 2157 of file DefaultPreferencesFactory.php.
Referenced by saveFormData().
|
protected |
| string | $signature | |
| array | $alldata | |
| HTMLForm | $form |
Definition at line 2000 of file DefaultPreferencesFactory.php.
Referenced by profilePreferences().
|
protected |
| User | $user | |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 1044 of file DefaultPreferencesFactory.php.
References MediaWiki\Html\element(), getDateOptions(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\MainConfigNames\LocalTZoffset, and wfTimestampNow().
Referenced by getFormDescriptor().
|
protected |
| User | $user | |
| MessageLocalizer | $l10n | |
| array | &$defaultPreferences |
Definition at line 1174 of file DefaultPreferencesFactory.php.
References MediaWiki\MainConfigNames\AllowUserCssPrefs, MediaWiki\MainConfigNames\EnableEditRecovery, MediaWiki\User\User\isAllowed(), and MediaWiki\Language\MessageLocalizer\msg().
Referenced by getFormDescriptor().
|
protected |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 1004 of file DefaultPreferencesFactory.php.
References getImageSizes(), getNormalizedThumbSizes(), getThumbSizes(), MediaWiki\Context\IContextSource\getUser(), MediaWiki\Language\MessageLocalizer\msg(), and MediaWiki\MainConfigNames\ThumbLimits.
Referenced by getFormDescriptor().
|
protected |
| User | $user | |
| IContextSource | $context | |
| array | $validSkinNames |
Definition at line 1780 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 skinPreferences().
|
protected |
| IContextSource | $context |
Definition at line 1844 of file DefaultPreferencesFactory.php.
References $wgDefaultUserOptions, MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\Language\MessageLocalizer\msg(), and wfTimestampNow().
Referenced by datetimePreferences().
| MediaWiki\Preferences\DefaultPreferencesFactory::getForm | ( | User | $user, |
| IContextSource | $context, | ||
| $formClass = PreferencesFormOOUI::class, | |||
| array | $remove = [] ) |
| User | $user | |
| IContextSource | $context | |
| class-string<PreferencesFormOOUI> | $formClass | |
| array | $remove | Array of items to remove |
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 2018 of file DefaultPreferencesFactory.php.
References getFormDescriptor(), MediaWiki\Context\IContextSource\getOutput(), MediaWiki\Context\IContextSource\getRequest(), MediaWiki\Context\IContextSource\getTitle(), MediaWiki\User\User\isAllowed(), and submitForm().
| MediaWiki\Preferences\DefaultPreferencesFactory::getFormDescriptor | ( | User | $user, |
| IContextSource | $context ) |
| User | $user | |
| IContextSource | $context |
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 237 of file DefaultPreferencesFactory.php.
References datetimePreferences(), editingPreferences(), filesPreferences(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\Context\IContextSource\getSkin(), profilePreferences(), rcPreferences(), renderingPreferences(), searchPreferences(), skinPreferences(), and watchlistPreferences().
Referenced by getForm(), and getResetKinds().
|
protected |
| MessageLocalizer | $l10n |
Definition at line 1878 of file DefaultPreferencesFactory.php.
References MediaWiki\MainConfigNames\ImageLimits, and MediaWiki\Language\MessageLocalizer\msg().
Referenced by filesPreferences().
|
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.
| array | $limits | as defined in $wgThumbLimits |
| array | $defaultUserOptions |
Definition at line 1906 of file DefaultPreferencesFactory.php.
Referenced by filesPreferences().
|
protected |
Pull option from a user account.
Handles stuff like array-type preferences.
| string | $name | |
| array | $info | |
| array | $userOptions |
Definition at line 395 of file DefaultPreferencesFactory.php.
References $options.
| MediaWiki\Preferences\DefaultPreferencesFactory::getOptionNamesForReset | ( | User | $user, |
| IContextSource | $context, | ||
| $kinds ) |
| User | $user | |
| IContextSource | $context | |
| string | string[] | $kinds |
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 2313 of file DefaultPreferencesFactory.php.
References getResetKinds(), and listResetKinds().
Referenced by saveFormData().
|
static |
Get preference values for the 'default' param of html form descriptor, compatible with nested fields.
| string | $name | |
| HTMLFormField | $field | |
| array | $userOptions |
Definition at line 368 of file DefaultPreferencesFactory.php.
| MediaWiki\Preferences\DefaultPreferencesFactory::getResetKinds | ( | User | $user, |
| IContextSource | $context, | ||
| $options = null ) |
| User | $user | |
| IContextSource | $context | |
| array | null | $options |
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 2218 of file DefaultPreferencesFactory.php.
References $options, getFormDescriptor(), and getSaveBlacklist().
Referenced by getOptionNamesForReset().
| MediaWiki\Preferences\DefaultPreferencesFactory::getSaveBlacklist | ( | ) |
Get the names of preferences that should never be saved (such as 'realname' and 'emailaddress').
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 225 of file DefaultPreferencesFactory.php.
Referenced by getResetKinds(), and saveFormData().
|
protected |
| MessageLocalizer | $l10n |
Definition at line 1918 of file DefaultPreferencesFactory.php.
References MediaWiki\Language\MessageLocalizer\msg(), and MediaWiki\MainConfigNames\ThumbLimits.
Referenced by filesPreferences().
| MediaWiki\Preferences\DefaultPreferencesFactory::listResetKinds | ( | ) |
Return a list of the types of user options currently returned by getResetKinds().
Currently, the option kinds are:
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.
Implements MediaWiki\Preferences\PreferencesFactory.
Definition at line 2295 of file DefaultPreferencesFactory.php.
References return.
Referenced by getOptionNamesForReset().
|
protected |
| User | $user | |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 445 of file DefaultPreferencesFactory.php.
References $options, cleanSignature(), MediaWiki\Html\element(), MediaWiki\MainConfigNames\EmailAuthentication, MediaWiki\MainConfigNames\EmailConfirmToEdit, MediaWiki\MainConfigNames\EnableEmail, MediaWiki\MainConfigNames\EnableUserEmail, MediaWiki\MainConfigNames\EnotifMinorEdits, MediaWiki\MainConfigNames\EnotifRevealEditorAddress, MediaWiki\MainConfigNames\EnotifUserTalk, MediaWiki\MainConfigNames\EnotifWatchlist, MediaWiki\MainConfigNames\ForceHTTPS, MediaWiki\User\User\getEditCount(), MediaWiki\User\User\getEmail(), MediaWiki\User\User\getEmailAuthenticationTimestamp(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\User\User\getName(), MediaWiki\Context\IContextSource\getOutput(), MediaWiki\User\User\getRealName(), MediaWiki\User\User\getRegistration(), MediaWiki\Context\IContextSource\getRequest(), MediaWiki\Context\IContextSource\getTitle(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\User\User\getTitleKey(), MediaWiki\Context\IContextSource\getUser(), MediaWiki\User\User\isAllowed(), MediaWiki\MainConfigNames\LanguageCode, MediaWiki\MainConfigNames\MaxSigChars, MediaWiki\Language\MessageLocalizer\msg(), MediaWiki\Message\Message\numParam(), MediaWiki\Specials\SpecialListGroupRights\RESTRICTED_GROUPS_SECTION_ID, MediaWiki\MainConfigNames\ScriptPath, MediaWiki\MainConfigNames\SecureLogin, MediaWiki\MainConfigNames\SignatureValidation, and validateSignature().
Referenced by getFormDescriptor().
|
protected |
| User | $user | |
| MessageLocalizer | $l10n | |
| array | &$defaultPreferences |
Definition at line 1254 of file DefaultPreferencesFactory.php.
References MediaWiki\Message\Message\numParam(), MediaWiki\MainConfigNames\RCMaxAge, MediaWiki\MainConfigNames\RCShowWatchingUsers, MediaWiki\MainConfigNames\RCWatchCategoryMembership, MediaWiki\User\User\useNPPatrol(), and MediaWiki\User\User\useRCPatrol().
Referenced by getFormDescriptor().
|
protected |
| User | $user | |
| MessageLocalizer | $l10n | |
| array | &$defaultPreferences |
Definition at line 1113 of file DefaultPreferencesFactory.php.
References MediaWiki\MainConfigNames\AllowUserCssPrefs, MediaWiki\User\User\isAllowed(), and MediaWiki\Language\MessageLocalizer\msg().
Referenced by getFormDescriptor().
|
protected |
Handle the form submission if everything validated properly.
| array | $formData | |
| PreferencesFormOOUI | $form | |
| array[] | $formDescriptor |
Definition at line 2080 of file DefaultPreferencesFactory.php.
References applyFilters(), MediaWiki\Context\ContextSource\getContext(), MediaWiki\Specials\Forms\PreferencesFormOOUI\getModifiedUser(), getOptionNamesForReset(), getSaveBlacklist(), and MediaWiki\MainConfigNames\HiddenPrefs.
Referenced by submitForm().
|
protected |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 1574 of file DefaultPreferencesFactory.php.
References MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\Message\Message\listParam(), MediaWiki\Language\MessageLocalizer\msg(), NS_FILE, NS_MAIN, MediaWiki\MainConfigNames\SearchMatchRedirectPreference, and MediaWiki\MainConfigNames\ThumbnailNamespaces.
Referenced by getFormDescriptor().
|
static |
Simplify form descriptor for validation or something similar.
| array | $descriptor | HTML form descriptor. |
Definition at line 268 of file DefaultPreferencesFactory.php.
Referenced by MediaWiki\Api\ApiOptionsBase\getHtmlForm().
|
protected |
| User | $user | |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 935 of file DefaultPreferencesFactory.php.
References MediaWiki\MainConfigNames\AllowUserCss, MediaWiki\MainConfigNames\AllowUserJs, generateSkinOptions(), MediaWiki\Context\IContextSource\getLanguage(), MediaWiki\User\User\getName(), MediaWiki\Language\MessageLocalizer\msg(), and NS_USER.
Referenced by getFormDescriptor().
|
protected |
Save the form data and reload the page.
| array | $formData | |
| PreferencesFormOOUI | $form | |
| array | $formDescriptor |
Definition at line 2186 of file DefaultPreferencesFactory.php.
References $url, MediaWiki\Context\ContextSource\getContext(), MediaWiki\Specials\Forms\PreferencesFormOOUI\getExtraSuccessRedirectParameters(), MediaWiki\Context\ContextSource\getRequest(), MediaWiki\HTMLForm\HTMLForm\getTitle(), and saveFormData().
Referenced by getForm().
|
protected |
| mixed | $signature | |
| array | $alldata | |
| HTMLForm | $form |
Definition at line 1936 of file DefaultPreferencesFactory.php.
References MediaWiki\Context\ContextSource\getContext(), MediaWiki\Context\ContextSource\getUser(), MediaWiki\MainConfigNames\MaxSigChars, MediaWiki\Context\ContextSource\msg(), and MediaWiki\MainConfigNames\SignatureValidation.
Referenced by profilePreferences().
|
protected |
| User | $user | |
| IContextSource | $context | |
| array | &$defaultPreferences |
Definition at line 1355 of file DefaultPreferencesFactory.php.
References $options, MediaWiki\Specials\SpecialWatchlist\checkStructuredFilterUiEnabled(), MediaWiki\MainConfigNames\EnableWatchlistLabels, MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\User\User\isAllowed(), MediaWiki\User\User\isAllowedAny(), MediaWiki\Language\MessageLocalizer\msg(), MediaWiki\Message\Message\numParam(), MediaWiki\MainConfigNames\RCMaxAge, MediaWiki\MainConfigNames\RCWatchCategoryMembership, MediaWiki\User\User\useRCPatrol(), and MediaWiki\MainConfigNames\WatchlistExpiry.
Referenced by getFormDescriptor().
|
protected |
Definition at line 80 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
The wiki's content language.
Definition at line 74 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
Definition at line 77 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
Definition at line 83 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
Definition at line 86 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
Definition at line 71 of file DefaultPreferencesFactory.php.
Referenced by __construct(), getOptionFromUser(), getResetKinds(), profilePreferences(), and watchlistPreferences().
|
protected |
Definition at line 89 of file DefaultPreferencesFactory.php.
Referenced by __construct().
|
protected |
Definition at line 98 of file DefaultPreferencesFactory.php.
| const MediaWiki\Preferences\DefaultPreferencesFactory::CONSTRUCTOR_OPTIONS |
Definition at line 118 of file DefaultPreferencesFactory.php.