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

Detailed Description

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 49 of file Preferences.php.

Member Function Documentation

◆ cleanSignature()

static Preferences::cleanSignature	(	$signature,
		$alldata,
		$form
	)

static

Parameters

string	$signature
array	$alldata
HTMLForm	$form

Returns: string

Definition at line 1331 of file Preferences.php.

References $wgParser, and global.

◆ datetimePreferences()

static Preferences::datetimePreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 690 of file Preferences.php.

References $context, $defaultPreferences, $e, $lang, $user, captcha-old\count, Xml\element(), HTMLFormField\flattenOptions(), getDateOptions(), getTimezoneOptions(), Html\hidden(), and wfTimestampNow().

Referenced by getPreferences().

◆ editingPreferences()

static Preferences::editingPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 828 of file Preferences.php.

References $context, $defaultPreferences, and $user.

Referenced by getPreferences().

◆ filesPreferences()

static Preferences::filesPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 668 of file Preferences.php.

References $context, $defaultPreferences, getImageSizes(), and getThumbSizes().

Referenced by getPreferences().

◆ filterIntval()

static Preferences::filterIntval	(	$value,
		$alldata
	)

static

Parameters

string	$value
array	$alldata

Returns: int

Definition at line 1435 of file Preferences.php.

References $value.

◆ filterTimezoneInput()

static Preferences::filterTimezoneInput	(	$tz,
		$alldata
	)

static

Parameters

string	$tz
array	$alldata

Returns: string

Definition at line 1444 of file Preferences.php.

References $e, and captcha-old\count.

◆ generateSkinOptions()

static Preferences::generateSkinOptions	(		$user,
		IContextSource	$context
	)

static

Parameters

User	$user	The User object
IContextSource	$context

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

Definition at line 1166 of file Preferences.php.

References $context, $linkRenderer, $ret, $user, as, Skin\getAllowedSkins(), Title\makeTitleSafe(), Title\newMainPage(), and NS_USER.

Referenced by skinPreferences().

◆ getDateOptions()

static Preferences::getDateOptions ( IContextSource $context )

static

Parameters

IContextSource $context

Returns: array

Definition at line 1236 of file Preferences.php.

References $context, $lang, $ret, $wgDefaultUserOptions, as, global, and wfTimestampNow().

Referenced by datetimePreferences().

◆ getFormObject()

static Preferences::getFormObject	(		$user,
		IContextSource	$context,
			$formClass = `'PreferencesForm'`,
		array	$remove = `[]`
	)

static

Parameters

User	$user
IContextSource	$context
string	$formClass
array	$remove	Array of items to remove

Returns: PreferencesForm|HtmlForm

Definition at line 1350 of file Preferences.php.

References $context, $name, $user, as, captcha-old\count, and getPreferences().

Referenced by SpecialPreferences\getFormObject().

◆ getImageSizes()

static Preferences::getImageSizes ( IContextSource $context )

static

Parameters

IContextSource $context

Returns: array

Definition at line 1270 of file Preferences.php.

References $context, $ret, and as.

Referenced by filesPreferences().

◆ getOptionFromUser()

static Preferences::getOptionFromUser	(	$name,
		$info,
		$user
	)

static

Pull option from a user account.

Handles stuff like array-type preferences.

Parameters

string	$name
array	$info
User	$user

Returns: array|string

Definition at line 163 of file Preferences.php.

References $name, $options, $rows, $user, $value, as, and HTMLFormField\flattenOptions().

Referenced by loadPreferenceValues().

◆ getPreferences()

static Preferences::getPreferences	(		$user,
		IContextSource	$context
	)

static

Exceptions

MWException

Parameters

User	$user
IContextSource	$context

Returns: array|null

Definition at line 80 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().

◆ getSaveBlacklist()

static Preferences::getSaveBlacklist ( )

static

Returns: array

Definition at line 70 of file Preferences.php.

References $saveBlacklist.

Referenced by User\getOptionKinds().

◆ getThumbSizes()

static Preferences::getThumbSizes ( IContextSource $context )

static

Parameters

IContextSource $context

Returns: array

Definition at line 1287 of file Preferences.php.

References $context, $ret, and as.

Referenced by filesPreferences().

◆ getTimeZoneList()

static Preferences::getTimeZoneList ( Language $language )

static

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

Since: 1.26

Definition at line 1596 of file Preferences.php.

References $value, as, captcha-old\count, and wfMessage().

Referenced by getTimezoneOptions().

◆ getTimezoneOptions()

static Preferences::getTimezoneOptions ( IContextSource $context )

static

Parameters

IContextSource $context

Returns: array

Definition at line 1390 of file Preferences.php.

References $context, $opt, as, MWTimestamp\getLocalInstance(), and getTimeZoneList().

Referenced by datetimePreferences().

◆ loadPreferenceValues()

static Preferences::loadPreferenceValues	(		$user,
			$context,
		&	$defaultPreferences
	)

static

Loads existing values for a given array of preferences.

Exceptions

MWException

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences	Array to load values for

Returns: array|null

Definition at line 113 of file Preferences.php.

References $context, $defaultPreferences, $name, $user, as, User\getDefaultOptions(), getOptionFromUser(), and HTMLForm\loadInputFromParameters().

Referenced by getPreferences().

◆ miscPreferences()

static Preferences::miscPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Dummy, kept for backwards-compatibility.

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 1158 of file Preferences.php.

Referenced by getPreferences().

◆ profilePreferences()

static Preferences::profilePreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 206 of file Preferences.php.

References $code, $context, $defaultPreferences, $lang, $languages, $link, $linkRenderer, $name, $options, $t, $time, $user, $wgContLang, $wgParser, as, captcha-old\count, CentralIdLookup\factory(), Language\fetchLanguageNames(), UserGroupMembership\getExpiry(), UserGroupMembership\getLink(), MediaWiki\getTitle(), SpecialPage\getTitleFor(), global, ParserOptions\newFromContext(), text, wfBCP47(), and wfCanIPUseHTTPS().

Referenced by getPreferences(), and PreferencesTest\prefsFor().

◆ rcPreferences()

static Preferences::rcPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 901 of file Preferences.php.

References $context, $defaultPreferences, and $user.

Referenced by getPreferences().

◆ renderingPreferences()

static Preferences::renderingPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 766 of file Preferences.php.

References $context, $defaultPreferences, $value, and as.

Referenced by getPreferences().

◆ searchPreferences()

static Preferences::searchPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 1144 of file Preferences.php.

References $defaultPreferences, as, and MWNamespace\getValidNamespaces().

Referenced by getPreferences().

◆ skinPreferences()

static Preferences::skinPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Returns: void

Definition at line 619 of file Preferences.php.

References $context, $defaultPreferences, $linkRenderer, $user, generateSkinOptions(), Title\makeTitleSafe(), and NS_USER.

Referenced by getPreferences().

◆ tryFormSubmit()

static Preferences::tryFormSubmit	(	$formData,
		$form
	)

static

Handle the form submission if everything validated properly.

Parameters

array	$formData
PreferencesForm	$form

Returns: bool|Status|string

Definition at line 1496 of file Preferences.php.

References $name, $user, $value, as, MediaWiki\Auth\AuthManager\callLegacyAuthPlugin(), StatusValue\newFatal(), and Hooks\run().

Referenced by PreferencesTest\testPreferencesFormPreSaveHookHasCorrectData(), and tryUISubmit().

◆ tryUISubmit()

static Preferences::tryUISubmit	(	$formData,
		$form
	)

static

Parameters

array	$formData
PreferencesForm	$form

Returns: Status

Definition at line 1564 of file Preferences.php.

References $context, $res, StatusValue\newGood(), and tryFormSubmit().

◆ validateSignature()

static Preferences::validateSignature	(	$signature,
		$alldata,
		$form
	)

static

Parameters

string	$signature
array	$alldata
HTMLForm	$form

Returns: bool|string

Definition at line 1305 of file Preferences.php.

References $wgParser, Xml\element(), false, and global.

◆ watchlistPreferences()

static Preferences::watchlistPreferences	(		$user,
		IContextSource	$context,
		&	$defaultPreferences
	)

static

Parameters

User	$user
IContextSource	$context
array	&$defaultPreferences

Definition at line 989 of file Preferences.php.

References $context, $defaultPreferences, $linkRenderer, $user, as, false, and SpecialPage\getTitleFor().

Referenced by getPreferences().

Member Data Documentation

◆ $defaultPreferences

array Preferences::$defaultPreferences = null

staticprotected

Definition at line 51 of file Preferences.php.

Referenced by datetimePreferences(), editingPreferences(), filesPreferences(), getPreferences(), loadPreferenceValues(), profilePreferences(), rcPreferences(), renderingPreferences(), searchPreferences(), skinPreferences(), and watchlistPreferences().

◆ $saveBlacklist

Preferences::$saveBlacklist

staticprivate

Initial value:

= [
        'realname',
        'emailaddress',
    ]

Definition at line 62 of file Preferences.php.

Referenced by getSaveBlacklist().

◆ $saveFilters

array Preferences::$saveFilters

staticprotected

Initial value:

= [
        'timecorrection' => [ 'Preferences', 'filterTimezoneInput' ],
        'rclimit' => [ 'Preferences', 'filterIntval' ],
        'wllimit' => [ 'Preferences', 'filterIntval' ],
        'searchlimit' => [ 'Preferences', 'filterIntval' ],
    ]

Definition at line 54 of file Preferences.php.

The documentation for this class was generated from the following file:

includes/Preferences.php

Static Public Member Functions

Static Protected Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ cleanSignature()

◆ datetimePreferences()

◆ editingPreferences()

◆ filesPreferences()

◆ filterIntval()

◆ filterTimezoneInput()

◆ generateSkinOptions()

◆ getDateOptions()

◆ getFormObject()

◆ getImageSizes()

◆ getOptionFromUser()

◆ getPreferences()

◆ getSaveBlacklist()

◆ getThumbSizes()

◆ getTimeZoneList()

◆ getTimezoneOptions()

◆ loadPreferenceValues()

◆ miscPreferences()

◆ profilePreferences()

◆ rcPreferences()

◆ renderingPreferences()

◆ searchPreferences()

◆ skinPreferences()

◆ tryFormSubmit()

◆ tryUISubmit()

◆ validateSignature()

◆ watchlistPreferences()

Member Data Documentation

◆ $defaultPreferences

◆ $saveBlacklist

◆ $saveFilters