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

Inheritance diagram for PreferencesForm:

[legend]

Collaboration diagram for PreferencesForm:

[legend]

Public Member Functions
	filterDataForSubmit ( $data)
	Separate multi-option preferences into multiple preferences, since we have to store them separately. More...

	getBody ()
	Get the whole body of the form. More...

	getButtons ()

	getExtraSuccessRedirectParameters ()
	Get extra parameters for the query string when redirecting after successful save. More...

	getLegend ( $key)
	Get the "<legend>" for a given section key. More...

	getModifiedUser ()

	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. More...

	addButton ( $name, $value, $id=null, $attribs=null)
	Add a button to the form. More...

	addFooterText ( $msg, $section=null)
	Add footer text, inside the form. More...

	addHeaderText ( $msg, $section=null)
	Add header text, inside the form. More...

	addHiddenField ( $name, $value, $attribs=array())
	Add a hidden field to the output. More...

	addHiddenFields (array $fields)
	Add an array of hidden fields to the output. More...

	addPostText ( $msg)
	Add text to the end of the display. More...

	addPreText ( $msg)
	Add introductory text. More...

	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. More...

	displaySection ( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)

	getAction ()
	Get the value for the action attribute of the form. More...

	getDisplayFormat ()
	Getter for displayFormat. More...

	getErrors ( $errors)
	Format and display an error message stack. More...

	getHiddenFields ()
	Get the hidden fields that should go inside the form. More...

	getHTML ( $submitResult)
	Returns the raw HTML generated by the form. More...

	getMethod ()

	getSubmitText ()
	Get the text for the submit button, either customised or a default. More...

	getTitle ()
	Get the title. More...

	isVForm ()
	Test if displayFormat is 'vform'. More...

	loadData ()
	Construct the form fields from the Descriptor array. More...

	prepareForm ()
	Prepare form for submission. More...

	setAction ( $action)
	Set the value for the action attribute of the form. More...

	setDisplayFormat ( $format)
	Set format in which to display the form. More...

	setFooterText ( $msg, $section=null)
	Set footer text, inside the form. More...

	setHeaderText ( $msg, $section=null)
	Set header text, inside the form. More...

	setId ( $id)

	setIntro ( $msg)
	Set the introductory message, overwriting any existing message. More...

	setMessagePrefix ( $p)
	Set the prefix for various default messages. More...

	setMethod ( $method='post')
	Set the method used to submit the form. More...

	setPostText ( $msg)
	Set text at the end of the display. More...

	setPreText ( $msg)
	Set the introductory message, overwriting any existing message. More...

	setSubmitCallback ( $cb)
	Set a callback to a function to do something with the form once it's been successfully validated. More...

	setSubmitID ( $t)
	Set the id for the submit button. More...

	setSubmitName ( $name)

	setSubmitText ( $t)
	Set the text for the submit button. More...

	setSubmitTextMsg ( $msg)
	Set the text for the submit button to a message. More...

	setSubmitTooltip ( $name)

	setTableId ( $id)
	Set the id of the <table> or outermost <div> element. More...

	setTitle ( $t)
	Set the title for form submission. More...

	setValidationErrorMessage ( $msg)
	Set a message to display on a validation error. More...

	setWrapperLegend ( $legend)
	Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element. More...

	setWrapperLegendMsg ( $msg)
	Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element. More...

	show ()
	The here's-one-I-made-earlier option: do the submission if posted, or display the form with or without funky validation errors. More...

	suppressDefaultSubmit ( $suppressSubmit=true)
	Stop a default submit button being shown for this form. More...

	suppressReset ( $suppressReset=true)
	Stop a reset button being shown for this form. More...

	tryAuthorizedSubmit ()
	Try submitting, with edit token check first. More...

	trySubmit ()
	Validate all the fields, and call the submission callback function if everything is kosher. More...

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()
	Get the Config object. More...

	getContext ()
	Get the RequestContext object. More...

	getLang ()
	Get the Language object. More...

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getUser ()
	Get the User object. More...

	getWikiPage ()
	Get the WikiPage object. More...

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Protected Attributes
	$mSubSectionBeforeFields = false

Protected Attributes inherited from HTMLForm
Array	$availableDisplayFormats
	Available formats in which to display the form. More...

String	$displayFormat = 'table'
	Format in which to display form. More...

bool string	$mAction = false
	Form action URL. More...

	$mButtons = array()

	$mFieldTree

HTMLFormField[]	$mFlatFields

	$mFooter = ''

	$mHeader = ''

	$mHiddenFields = array()

	$mId

	$mMessagePrefix

	$mMethod = 'post'

	$mPost = ''

	$mPre = ''

	$mSectionFooters = array()

	$mSectionHeaders = array()

	$mShowReset = false

	$mShowSubmit = true

	$mSubmitCallback

	$mSubmitID

	$mSubmitName

	$mSubmitText

	$mSubmitTooltip

	$mSubSectionBeforeFields = true
	If true, sections that contain both fields and subsections will render their subsections before their fields. More...

	$mTableId = ''

	$mTitle

	$mUseMultipart = false

	$mValidationErrorMessage

	$mWrapperLegend = false

Private Attributes
	$modifiedUser

Additional Inherited Members
Static Public Member Functions inherited from HTMLForm
static	addJS ()
	Add the HTMLForm-specific JavaScript, if it hasn't been done already. More...

static	formatErrors ( $errors)
	Format a stack of error messages into a single HTML string. More...

static	getClassFromDescriptor ( $fieldname, &$descriptor)
	Get the HTMLFormField subclass for this descriptor. More...

static	loadInputFromParameters ( $fieldname, $descriptor)
	Initialise a new Object for the field. More...

Public Attributes inherited from HTMLForm
	$mFieldData

Static Public Attributes inherited from HTMLForm
static	$typeMappings

Detailed Description

Some tweaks to allow js prefs to work.

Definition at line 1508 of file Preferences.php.

Member Function Documentation

◆ filterDataForSubmit()

PreferencesForm::filterDataForSubmit ( $data )

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

Parameters

$data array

Returns: array

Reimplemented from HTMLForm.

Definition at line 1579 of file Preferences.php.

References $value, and as.

◆ getBody()

PreferencesForm::getBody ( )

Get the whole body of the form.

Returns: string

Reimplemented from HTMLForm.

Definition at line 1598 of file Preferences.php.

References HTMLForm\displaySection().

◆ getButtons()

PreferencesForm::getButtons ( )

Returns: String

Reimplemented from HTMLForm.

Definition at line 1555 of file Preferences.php.

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

◆ getExtraSuccessRedirectParameters()

PreferencesForm::getExtraSuccessRedirectParameters ( )

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

Returns: array()

Definition at line 1538 of file Preferences.php.

References array().

◆ 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

$key string

Returns: string

Reimplemented from HTMLForm.

Definition at line 1608 of file Preferences.php.

References array(), and wfRunHooks().

◆ getModifiedUser()

PreferencesForm::getModifiedUser ( )

Returns: User

Definition at line 1524 of file Preferences.php.

References $modifiedUser, and ContextSource\getUser().

Referenced by getButtons().

◆ setModifiedUser()

PreferencesForm::setModifiedUser ( $user )

Parameters

$user User

Definition at line 1517 of file Preferences.php.

References $user.

◆ wrapForm()

PreferencesForm::wrapForm ( $html )

Parameters

$html string

Returns: String

Reimplemented from HTMLForm.

Definition at line 1546 of file Preferences.php.

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

Member Data Documentation

◆ $modifiedUser

PreferencesForm::$modifiedUser

private

Definition at line 1512 of file Preferences.php.

Referenced by getModifiedUser().

◆ $mSubSectionBeforeFields

PreferencesForm::$mSubSectionBeforeFields = false

protected

Definition at line 1510 of file Preferences.php.

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

includes/Preferences.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ filterDataForSubmit()

◆ getBody()

◆ getButtons()

◆ getExtraSuccessRedirectParameters()

◆ getLegend()

◆ getModifiedUser()

◆ setModifiedUser()

◆ wrapForm()

Member Data Documentation

◆ $modifiedUser

◆ $mSubSectionBeforeFields