MediaWiki
1.29.1
|
We're now using the HTMLForm object with some customisation to generate the Preferences form. More...
Static Public Member Functions | |
static | cleanSignature ( $signature, $alldata, $form) |
static | datetimePreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | editingPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | filesPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | filterIntval ( $value, $alldata) |
static | filterTimezoneInput ( $tz, $alldata) |
static | generateSkinOptions ( $user, IContextSource $context) |
static | getDateOptions (IContextSource $context) |
static | getFormObject ( $user, IContextSource $context, $formClass='PreferencesForm', array $remove=[]) |
static | getImageSizes (IContextSource $context) |
static | getOptionFromUser ( $name, $info, $user) |
Pull option from a user account. More... | |
static | getPreferences ( $user, IContextSource $context) |
static | getSaveBlacklist () |
static | getThumbSizes (IContextSource $context) |
static | getTimeZoneList (Language $language) |
Get a list of all time zones. More... | |
static | getTimezoneOptions (IContextSource $context) |
static | loadPreferenceValues ( $user, $context, &$defaultPreferences) |
Loads existing values for a given array of preferences. More... | |
static | miscPreferences ( $user, IContextSource $context, &$defaultPreferences) |
Dummy, kept for backwards-compatibility. More... | |
static | profilePreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | rcPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | renderingPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | searchPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | skinPreferences ( $user, IContextSource $context, &$defaultPreferences) |
static | tryFormSubmit ( $formData, $form) |
Handle the form submission if everything validated properly. More... | |
static | tryUISubmit ( $formData, $form) |
static | validateSignature ( $signature, $alldata, $form) |
static | watchlistPreferences ( $user, IContextSource $context, &$defaultPreferences) |
Static Protected Attributes | |
static array | $defaultPreferences = null |
static array | $saveFilters |
Static Private Attributes | |
static | $saveBlacklist |
We're now using the HTMLForm object with some customisation to generate the Preferences form.
This object handles generic submission, CSRF protection, layout and other logic in a reusable manner. We subclass it as a PreferencesForm to make some minor customisations.
In order to generate the form, the HTMLForm object needs an array structure detailing the form fields available, and that's what this class is for. Each element of the array is a basic property-list, including the type of field, the label it is to be given in the form, callbacks for validation and 'filtering', and other pertinent information. Note that the 'default' field is named for generic forms, and does not represent the preference's default (which is stored in $wgDefaultUserOptions), but the default for the form field, which should be whatever the user has set for that preference. There is no need to override it unless you have some special storage logic (for instance, those not presently stored as options, but which are best set from the user preferences view).
Field types are implemented as subclasses of the generic HTMLFormField object, and typically implement at least getInputHTML, which generates the HTML for the input field to be placed in the table.
Once fields have been retrieved and validated, submission logic is handed over to the tryUISubmit static method of this class.
Definition at line 51 of file Preferences.php.
|
static |
string | $signature | |
array | $alldata | |
HTMLForm | $form |
Definition at line 1291 of file Preferences.php.
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 677 of file Preferences.php.
References $context, $defaultPreferences, $e, $lang, $user, captcha-old\count, Xml\element(), HTMLFormField\flattenOptions(), getDateOptions(), ContextSource\getLanguage(), getTimezoneOptions(), Html\hidden(), and wfTimestampNow().
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 816 of file Preferences.php.
References $context, $defaultPreferences, $user, ContextSource\getConfig(), and ContextSource\msg().
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 655 of file Preferences.php.
References $context, $defaultPreferences, getImageSizes(), and getThumbSizes().
Referenced by getPreferences().
|
static |
string | $value | |
array | $alldata |
Definition at line 1395 of file Preferences.php.
References $value.
|
static |
string | $tz | |
array | $alldata |
Definition at line 1404 of file Preferences.php.
References $e, and captcha-old\count.
|
static |
User | $user | The User object |
IContextSource | $context |
Definition at line 1126 of file Preferences.php.
References $context, $linkRenderer, $ret, $user, as, Skin\getAllowedSkins(), ContextSource\getConfig(), ContextSource\getLanguage(), Title\makeTitleSafe(), ContextSource\msg(), Title\newMainPage(), and NS_USER.
Referenced by skinPreferences().
|
static |
IContextSource | $context |
Definition at line 1196 of file Preferences.php.
References $context, $lang, $ret, $wgDefaultUserOptions, as, ContextSource\getLanguage(), global, ContextSource\msg(), and wfTimestampNow().
Referenced by datetimePreferences().
|
static |
User | $user | |
IContextSource | $context | |
string | $formClass | |
array | $remove | Array of items to remove |
Definition at line 1310 of file Preferences.php.
References $context, $name, $user, as, captcha-old\count, getPreferences(), and ContextSource\msg().
Referenced by SpecialPreferences\execute().
|
static |
IContextSource | $context |
Definition at line 1230 of file Preferences.php.
References $context, $ret, as, ContextSource\getConfig(), and ContextSource\msg().
Referenced by filesPreferences().
|
static |
Pull option from a user account.
Handles stuff like array-type preferences.
string | $name | |
array | $info | |
User | $user |
Definition at line 165 of file Preferences.php.
References $name, $options, $user, $value, as, and HTMLFormField\flattenOptions().
Referenced by loadPreferenceValues().
|
static |
MWException |
User | $user | |
IContextSource | $context |
Definition at line 82 of file Preferences.php.
References $context, $defaultPreferences, $user, datetimePreferences(), editingPreferences(), filesPreferences(), loadPreferenceValues(), miscPreferences(), profilePreferences(), rcPreferences(), renderingPreferences(), Hooks\run(), searchPreferences(), skinPreferences(), and watchlistPreferences().
Referenced by ApiOptions\execute(), getFormObject(), and User\getOptionKinds().
|
static |
Definition at line 72 of file Preferences.php.
References $saveBlacklist.
Referenced by User\getOptionKinds().
|
static |
IContextSource | $context |
Definition at line 1247 of file Preferences.php.
References $context, $ret, as, ContextSource\getConfig(), and ContextSource\msg().
Referenced by filesPreferences().
|
static |
Get a list of all time zones.
Definition at line 1551 of file Preferences.php.
References $value, as, captcha-old\count, and wfMessage().
Referenced by getTimezoneOptions().
|
static |
IContextSource | $context |
Definition at line 1350 of file Preferences.php.
References $context, $opt, as, ContextSource\getConfig(), ContextSource\getLanguage(), MWTimestamp\getLocalInstance(), getTimeZoneList(), and ContextSource\msg().
Referenced by datetimePreferences().
|
static |
Loads existing values for a given array of preferences.
MWException |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences | Array to load values for |
Definition at line 115 of file Preferences.php.
References $context, $defaultPreferences, $name, $user, as, ContextSource\getConfig(), User\getDefaultOptions(), getOptionFromUser(), and HTMLForm\loadInputFromParameters().
Referenced by getPreferences().
|
static |
Dummy, kept for backwards-compatibility.
Definition at line 1118 of file Preferences.php.
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 208 of file Preferences.php.
References $code, $context, $defaultPreferences, $lang, $languages, $link, $linkRenderer, $name, $options, $t, $time, $user, $wgContLang, $wgParser, as, captcha-old\count, Language\fetchLanguageNames(), ContextSource\getConfig(), UserGroupMembership\getExpiry(), ContextSource\getLanguage(), UserGroupMembership\getLink(), ContextSource\getOutput(), ContextSource\getRequest(), ContextSource\getTitle(), SpecialPage\getTitleFor(), ContextSource\getUser(), global, ContextSource\msg(), ParserOptions\newFromContext(), text, wfBCP47(), and wfCanIPUseHTTPS().
Referenced by getPreferences(), and PreferencesTest\prefsFor().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 889 of file Preferences.php.
References $context, $defaultPreferences, $user, ContextSource\getConfig(), and ContextSource\msg().
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 754 of file Preferences.php.
References $context, $defaultPreferences, $value, as, ContextSource\getConfig(), and ContextSource\msg().
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 1107 of file Preferences.php.
References $defaultPreferences, as, and MWNamespace\getValidNamespaces().
Referenced by getPreferences().
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 605 of file Preferences.php.
References $context, $defaultPreferences, $linkRenderer, $user, generateSkinOptions(), ContextSource\getConfig(), ContextSource\getLanguage(), Title\makeTitleSafe(), ContextSource\msg(), and NS_USER.
Referenced by getPreferences().
|
static |
Handle the form submission if everything validated properly.
array | $formData | |
PreferencesForm | $form |
Definition at line 1456 of file Preferences.php.
References $name, $user, $value, as, MediaWiki\Auth\AuthManager\callLegacyAuthPlugin(), StatusValue\newFatal(), and Hooks\run().
Referenced by tryUISubmit().
|
static |
array | $formData | |
PreferencesForm | $form |
Definition at line 1519 of file Preferences.php.
References $context, $res, ContextSource\getContext(), ContextSource\getOutput(), ContextSource\getRequest(), StatusValue\newGood(), and tryFormSubmit().
|
static |
string | $signature | |
array | $alldata | |
HTMLForm | $form |
Definition at line 1265 of file Preferences.php.
References $wgParser, Xml\element(), false, and global.
|
static |
User | $user | |
IContextSource | $context | |
array | $defaultPreferences |
Definition at line 957 of file Preferences.php.
References $context, $defaultPreferences, $linkRenderer, $user, as, false, ContextSource\getConfig(), ContextSource\getLanguage(), SpecialPage\getTitleFor(), and ContextSource\msg().
Referenced by getPreferences().
|
staticprotected |
Definition at line 53 of file Preferences.php.
Referenced by datetimePreferences(), editingPreferences(), filesPreferences(), getPreferences(), loadPreferenceValues(), profilePreferences(), rcPreferences(), renderingPreferences(), searchPreferences(), skinPreferences(), and watchlistPreferences().
|
staticprivate |
Definition at line 64 of file Preferences.php.
Referenced by getSaveBlacklist().
|
staticprotected |
Definition at line 56 of file Preferences.php.