PreferencesForm Class Reference

Form to edit user preferences. More...

Inheritance diagram for PreferencesForm:

Collaboration diagram for PreferencesForm:

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 ()
	getPreferenceSections ()
	Get the keys of each top level preference section.
	setModifiedUser ( $user)
	wrapForm ( $html)
Public Member Functions inherited from HTMLForm
	__construct ( $descriptor, $context=null, $messagePrefix='')
	Build a new HTMLForm from an array of field attributes.
	addButton ( $data)
	Add a button to the form.
	addFooterText ( $msg, $section=null)
	Add footer text, inside the form.
	addHeaderText ( $msg, $section=null)
	Add HTML to the header, inside the form.
	addHiddenField ( $name, $value, array $attribs=[])
	Add a hidden field to the output.
	addHiddenFields (array $fields)
	Add an array of hidden fields to the output.
	addPostText ( $msg)
	Add text to the end of the display.
	addPreText ( $msg)
	Add HTML to introductory message.
	displayForm ( $submitResult)
	Display the form (sending to the context's OutputPage object), with an appropriate error message or stack of messages, and any validation errors, etc.
	displaySection ( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
	formatErrors ( $errors)
	Format a stack of error messages into a single HTML string.
	getAction ()
	Get the value for the action attribute of the form.
	getDisplayFormat ()
	Getter for displayFormat.
	getErrors ( $errors)
	Format and display an error message stack.
	getErrorsOrWarnings ( $elements, $elementsType)
	Returns a formatted list of errors or warnings from the given elements.
	getField ( $fieldname)
	getFooterText ( $section=null)
	Get footer text.
	getHeaderText ( $section=null)
	Get header text.
	getHiddenFields ()
	Get the hidden fields that should go inside the form.
	getHTML ( $submitResult)
	Returns the raw HTML generated by the form.
	getMethod ()
	getSubmitText ()
	Get the text for the submit button, either customised or a default.
	getTitle ()
	Get the title.
	hasField ( $fieldname)
	loadData ()
	Construct the form fields from the Descriptor array.
	needsJSForHtml5FormValidation ()
	Whether this form, with its current fields, requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.
	prepareForm ()
	Prepare form for submission.
	setAction ( $action)
	Set the value for the action attribute of the form.
	setAutocomplete ( $autocomplete)
	Set the value for the autocomplete attribute of the form.
	setCancelTarget ( $target)
	Sets the target where the user is redirected to after clicking cancel.
	setDisplayFormat ( $format)
	Set format in which to display the form.
	setFooterText ( $msg, $section=null)
	Set footer text, inside the form.
	setFormIdentifier ( $ident)
	Set an internal identifier for this form.
	setHeaderText ( $msg, $section=null)
	Set header text, inside the form.
	setId ( $id)
	setIntro ( $msg)
	Set the introductory message, overwriting any existing message.
	setMessagePrefix ( $p)
	Set the prefix for various default messages.
	setMethod ( $method='post')
	Set the method used to submit the form.
	setName ( $name)
	setPostText ( $msg)
	Set text at the end of the display.
	setPreText ( $msg)
	Set the introductory message HTML, overwriting any existing message.
	setSubmitCallback ( $cb)
	Set a callback to a function to do something with the form once it's been successfully validated.
	setSubmitDestructive ()
	Identify that the submit button in the form has a destructive action.
	setSubmitID ( $t)
	Set the id for the submit button.
	setSubmitName ( $name)
	setSubmitProgressive ()
	Identify that the submit button in the form has a progressive action.
	setSubmitText ( $t)
	Set the text for the submit button.
	setSubmitTextMsg ( $msg)
	Set the text for the submit button to a message.
	setSubmitTooltip ( $name)
	setTableId ( $id)
	Set the id of the \<table\> or outermost \<div\> element.
	setTitle ( $t)
	Set the title for form submission.
	setTokenSalt ( $salt)
	Set the salt for the edit token.
	setValidationErrorMessage ( $msg)
	Set a message to display on a validation error.
	setWrapperLegend ( $legend)
	Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.
	setWrapperLegendMsg ( $msg)
	Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
	show ()
	The here's-one-I-made-earlier option: do the submission if posted, or display the form with or without funky validation errors.
	showAlways ()
	Same as self::show with the difference, that the form will be added to the output, no matter, if the validation was good or not.
	showCancel ( $show=true)
	Show a cancel button (or prevent it).
	suppressDefaultSubmit ( $suppressSubmit=true)
	Stop a default submit button being shown for this form.
	suppressReset ( $suppressReset=true)
	Stop a reset button being shown for this form.
	tryAuthorizedSubmit ()
	Try submitting, with edit token check first.
	trySubmit ()
	Validate all the fields, and call the submission callback function if everything is kosher.
	wasSubmitted ()
	Test whether the form was considered to have been submitted or not, i.e.
Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.
	getConfig ()
	getContext ()
	Get the base IContextSource object.
	getLanguage ()
	getOutput ()
	getRequest ()
	getSkin ()
	getStats ()
	getTiming ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Protected Attributes
	$mSubSectionBeforeFields = false
Protected Attributes inherited from HTMLForm
array	$availableDisplayFormats
	Available formats in which to display the form.
array	$availableSubclassDisplayFormats
	Available formats in which to display the form.
string	$displayFormat = 'table'
	Format in which to display form.
bool string	$mAction = false
	Form action URL.
string null	$mAutocomplete = null
	Form attribute autocomplete.
	$mButtons = []
	$mCancelTarget
	$mFieldTree
HTMLFormField[]	$mFlatFields
	$mFooter = ''
	$mFormIdentifier
	$mHeader = ''
	$mHiddenFields = []
	$mId
	$mMessagePrefix
	$mMethod = 'post'
	$mName
	$mPost = ''
	$mPre = ''
	$mSectionFooters = []
	$mSectionHeaders = []
	$mShowCancel = false
	$mShowReset = false
	$mShowSubmit = true
	$mSubmitCallback
	$mSubmitFlags = [ 'primary', 'progressive' ]
	$mSubmitID
	$mSubmitName
	$mSubmitText
	$mSubmitTooltip
	$mSubSectionBeforeFields = true
	If true, sections that contain both fields and subsections will render their subsections before their fields.
	$mTableId = ''
	$mTitle
string array	$mTokenSalt = ''
	Salt for the edit token.
	$mUseMultipart = false
	$mValidationErrorMessage
	$mWasSubmitted = false
	$mWrapperLegend = false

Private Attributes
	$modifiedUser

Additional Inherited Members
Static Public Member Functions inherited from HTMLForm
static	factory ( $displayFormat)
	Construct a HTMLForm object for given display type.
static	getClassFromDescriptor ( $fieldname, &$descriptor)
	Get the HTMLFormField subclass for this descriptor.
static	loadInputFromParameters ( $fieldname, $descriptor, HTMLForm $parent=null)
	Initialise a new Object for the field.
Public Attributes inherited from HTMLForm
	$mFieldData
Static Public Attributes inherited from HTMLForm
static	$typeMappings
Protected Member Functions inherited from HTMLForm
	formatSection (array $fieldsHtml, $sectionName, $anyFieldHasLabel)
	Put a form section together from the individual fields' HTML, merging it and wrapping.
	getFormAttributes ()
	Get HTML attributes for the <form> tag.
	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
	wrapFieldSetSection ( $legend, $section, $attributes)
	Wraps the given $section into an user-visible fieldset.

Detailed Description

Form to edit user preferences.

Definition at line 26 of file PreferencesForm.php.

Member Function Documentation

filterDataForSubmit()

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 101 of file PreferencesForm.php.

References $value, and as.

getBody()

PreferencesForm::getBody

(

)

Get the whole body of the form.

Returns

string

Reimplemented from HTMLForm.

Definition at line 120 of file PreferencesForm.php.

References HTMLForm\displaySection().

getButtons()

PreferencesForm::getButtons

(

)

Returns

string

Reimplemented from HTMLForm.

Definition at line 73 of file PreferencesForm.php.

References $html, $linkRenderer, $t, getModifiedUser(), HTMLForm\getTitle(), ContextSource\msg(), and text.

getExtraSuccessRedirectParameters()

PreferencesForm::getExtraSuccessRedirectParameters

(

)

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

Returns

array

Definition at line 56 of file PreferencesForm.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

getLegend()

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 130 of file PreferencesForm.php.

getModifiedUser()

PreferencesForm::getModifiedUser

(

)

Returns

User

Definition at line 42 of file PreferencesForm.php.

References ContextSource\getUser().

Referenced by getButtons(), and MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData().

getPreferenceSections()

PreferencesForm::getPreferenceSections

(

)

Get the keys of each top level preference section.

Returns

array of section keys

Definition at line 140 of file PreferencesForm.php.

setModifiedUser()

PreferencesForm::setModifiedUser

(

$user

)

Parameters

User

$user

Definition at line 35 of file PreferencesForm.php.

References $user.

wrapForm()

PreferencesForm::wrapForm

(

$html

)

Parameters

string

$html

Returns

string

Reimplemented from HTMLForm.

Definition at line 64 of file PreferencesForm.php.

References $html.

Member Data Documentation

$modifiedUser

PreferencesForm::$modifiedUser

private

Definition at line 30 of file PreferencesForm.php.

$mSubSectionBeforeFields

PreferencesForm::$mSubSectionBeforeFields = false

protected

Definition at line 28 of file PreferencesForm.php.

---

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

• includes/specials/forms/PreferencesForm.php