PreferencesForm Class Reference

Some tweaks to allow js prefs to work. More...

Inheritance diagram for PreferencesForm:

Collaboration diagram for PreferencesForm:

List of all members.

Public Member Functions
	filterDataForSubmit ($data)
	Separate multi-option preferences into multiple preferences, since we have to store them separately.
	getBody ()
	Get the whole body of the form.
	getButtons ()
	getExtraSuccessRedirectParameters ()
	Get extra parameters for the query string when redirecting after successful save.
	getLegend ($key)
	Get the "<legend>" for a given section key.
	getModifiedUser ()
	setModifiedUser ($user)
	wrapForm ($html)
Protected Attributes
	$mSubSectionBeforeFields = false
	If true, sections that contain both fields and subsections will render their subsections before their fields.
Private Attributes
	$modifiedUser

---

Detailed Description

Some tweaks to allow js prefs to work.

Definition at line 1494 of file Preferences.php.

---

Member Function Documentation

PreferencesForm::filterDataForSubmit

(

$

data

)

Separate multi-option preferences into multiple preferences, since we have to store them separately.

Parameters:

array

$data

Returns:

array

Reimplemented from HTMLForm.

Definition at line 1573 of file Preferences.php.

References $key, $value, and as.

PreferencesForm::getBody

(

)

Get the whole body of the form.

Returns:

string

Reimplemented from HTMLForm.

Definition at line 1592 of file Preferences.php.

References HTMLForm\displaySection().

PreferencesForm::getButtons

(

)

Returns:

string

Reimplemented from HTMLForm.

Definition at line 1541 of file Preferences.php.

References $html, $t, array(), getModifiedUser(), SpecialPage\getTitleFor(), global, Linker\link(), ContextSource\msg(), and Xml\tags().

PreferencesForm::getExtraSuccessRedirectParameters

(

)

Get extra parameters for the query string when redirecting after successful save.

Returns:

array()

Definition at line 1524 of file Preferences.php.

References array().

PreferencesForm::getLegend

(

$

key

)

Get the "<legend>" for a given section key.

Normally this is the prefs-$key message but we'll allow extensions to override it.

Parameters:

string

$key

Returns:

string

Reimplemented from HTMLForm.

Definition at line 1602 of file Preferences.php.

References $key, array(), and wfRunHooks().

PreferencesForm::getModifiedUser

(

)

Returns:

User

Definition at line 1510 of file Preferences.php.

References ContextSource\getUser().

Referenced by getButtons().

PreferencesForm::setModifiedUser

(

$

user

)

Parameters:

User

$user

Definition at line 1503 of file Preferences.php.

References $user.

PreferencesForm::wrapForm

(

$

html

)

Parameters:

string

$html

Returns:

string

Reimplemented from HTMLForm.

Definition at line 1532 of file Preferences.php.

References $html, array(), and Xml\tags().

---

Member Data Documentation

PreferencesForm::$modifiedUser [private]

Definition at line 1498 of file Preferences.php.

PreferencesForm::$mSubSectionBeforeFields = false [protected]

If true, sections that contain both fields and subsections will render their subsections before their fields.

Subclasses may set this to false to render subsections after fields instead.

Reimplemented from HTMLForm.

Definition at line 1496 of file Preferences.php.

---

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

• includes/Preferences.php