Object handling generic submission, CSRF protection, layout and other logic for UI forms. More...

Inheritance diagram for HTMLForm:

Collaboration diagram for HTMLForm:

Public Member Functions
	__construct ($descriptor, $context=null, $messagePrefix= '')
	Build a new HTMLForm from an array of field attributes. More...

	addButton ($data)
	Add a button to the form. More...

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

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

	addHiddenField ($name, $value, array $attribs=[])
	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 HTML to introductory message. 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)

	filterDataForSubmit ($data)
	Overload this if you want to apply special filtration routines to the form as a whole, after it's submitted but before it's processed. More...

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

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

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

	getButtons ()
	Get the submit and (potentially) reset buttons. More...

	getDisplayFormat ()
	Getter for displayFormat. More...

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

	getFooterText ($section=null)
	Get footer text. More...

	getHeaderText ($section=null)
	Get header text. More...

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

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

	getLegend ($key)
	Get a string to go in the "<legend>" of a section fieldset. 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...

	setAutocomplete ($autocomplete)
	Set the value for the autocomplete 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...

	setName ($name)

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

	setPreText ($msg)
	Set the introductory message HTML, 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...

	setSubmitDestructive ()
	Identify that the submit button in the form has a destructive action. More...

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

	setSubmitName ($name)

	setSubmitProgressive ()
	Identify that the submit button in the form has a progressive action. More...

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

	setTokenSalt ($salt)
	Set the salt for the edit token. 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...

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

	wasSubmitted ()
	Test whether the form was considered to have been submitted or not, i.e. More...

	wrapForm ($html)
	Wrap the form innards in an actual "<form>" element. 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 base IContextSource 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...

	getStats ()
	Get the Stats object. More...

	getTiming ()
	Get the Timing object. More...

	getTitle ()
	Get the Title 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...

Static Public Member Functions
static	factory ($displayFormat)
	Construct a HTMLForm object for given display type. More...

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

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

Public Attributes
static	$mFieldData

Static Public Attributes
static	$typeMappings

Protected Member Functions
	formatSection (array $fieldsHtml, $sectionName, $anyFieldHasLabel)
	Put a form section together from the individual fields' HTML, merging it and wrapping. More...

	getFormAttributes ()
	Get HTML attributes for the `<form>` tag. More...

	getMessage ($value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. More...

	wrapFieldSetSection ($legend, $section, $attributes)
	Wraps the given $section into an user-visible fieldset. More...

Protected Attributes
array	$availableDisplayFormats
	Available formats in which to display the form. More...

array	$availableSubclassDisplayFormats
	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...

bool string	$mAutocomplete = false
	Form attribute autocomplete. More...

	$mButtons = []

	$mFieldTree

HTMLFormField[]	$mFlatFields

	$mFooter = ''

	$mHeader = ''

	$mHiddenFields = []

	$mId

	$mMessagePrefix

	$mMethod = 'post'

	$mName

	$mPost = ''

	$mPre = ''

	$mSectionFooters = []

	$mSectionHeaders = []

	$mShowReset = false

	$mShowSubmit = true

	$mSubmitCallback

	$mSubmitFlags = [ 'constructive', 'primary' ]

	$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

string array	$mTokenSalt = ''
	Salt for the edit token. More...

	$mUseMultipart = false

	$mValidationErrorMessage

	$mWasSubmitted = false

	$mWrapperLegend = false

Detailed Description

Object handling generic submission, CSRF protection, layout and other logic for UI forms.

in a reusable manner.

In order to generate the form, the HTMLForm object takes an array structure detailing the form fields available. 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.

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.

You can find extensive documentation on the www.mediawiki.org wiki:

The constructor input is an associative array of $fieldname => $info, where $info is an Associative Array with any of the following:

'class' – the subclass of HTMLFormField that will be used to create the object. NOT the CSS class! 'type' – roughly translates into the <select> type attribute. if 'class' is not specified, this is used as a map through HTMLForm::$typeMappings to get the class name. 'default' – default value when the form is displayed 'id' – HTML id attribute 'cssclass' – CSS class 'csshelpclass' – CSS class used to style help text 'dir' – Direction of the element. 'options' – associative array mapping labels to values. Some field types support multi-level arrays. 'options-messages' – associative array mapping message keys to values. Some field types support multi-level arrays. 'options-message' – message key or object to be parsed to extract the list of options (like 'ipbreason-dropdown'). 'label-message' – message key or object for a message to use as the label. can be an array of msg key and then parameters to the message. 'label' – alternatively, a raw text message. Overridden by label-message 'help' – message text for a message to use as a help text. 'help-message' – message key or object for a message to use as a help text. can be an array of msg key and then parameters to the message. Overwrites 'help-messages' and 'help'. 'help-messages' – array of message keys/objects. As above, each item can be an array of msg key and then parameters. Overwrites 'help'. 'required' – passed through to the object, indicating that it is a required field. 'size' – the length of text fields 'filter-callback' – a function name to give you the chance to massage the inputted value before it's processed.

See also: HTMLFormField::filter() 'validation-callback' – a function name to give you the chance to impose extra validation on the field input.; HTMLFormField::validate() 'name' – By default, the 'name' attribute of the input field is "wp{$fieldname}". If you want a different name (eg one without the "wp" prefix), specify it here and it will be used without modification. 'hide-if' – expression given as an array stating when the field should be hidden. The first array value has to be the expression's logic operator. Supported expressions: 'NOT' [ 'NOT', array $expression ] To hide a field if a given expression is not true. '===' [ '===', string $fieldName, string $value ] To hide a field if another field identified by $field has the value $value. '!==' [ '!==', string $fieldName, string $value ] Same as [ 'NOT', [ '===', $fieldName, $value ] 'OR', 'AND', 'NOR', 'NAND' [ 'XXX', array $expression1, ..., array $expressionN ] To hide a field if one or more (OR), all (AND), neither (NOR) or not all (NAND) given expressions are evaluated as true. The expressions will be given to a JavaScript frontend module which will continually update the field's visibility.

Since 1.20, you can chain mutators to ease the form generation:

Example:: $form = new HTMLForm( $someFields );

$form->setMethod( 'get' )

->setWrapperLegendMsg( 'message-key' )

->prepareForm()

->displayForm( '' );

Note that you will have prepareForm and displayForm at the end. Other methods call done after that would simply not be part of the form :(

Todo:: Document 'section' / 'subsection' stuff

Definition at line 123 of file HTMLForm.php.

Constructor & Destructor Documentation

HTMLForm::__construct	(	$descriptor,
		$context = `null`,
		$messagePrefix = `''`
	)

Build a new HTMLForm from an array of field attributes.

Parameters

array	$descriptor	Array of Field constructs, as described above
IContextSource	$context	Available since 1.18, will become compulsory in 1.18. Obviates the need to call $form->setTitle()
string	$messagePrefix	A prefix to go in front of default messages

Definition at line 291 of file HTMLForm.php.

References ContextSource\$context, $section, as, ContextSource\getConfig(), and ContextSource\setContext().

Member Function Documentation

HTMLForm::addButton ( $data )

Add a button to the form.

Since: 1.27 takes an array as shown. Earlier versions accepted 'name', 'value', 'id', and 'attribs' as separate parameters in that order.

Note: Custom labels ('label', 'label-message', 'label-raw') are not supported for IE6 and IE7 due to bugs in those browsers. If detected, they will be served buttons using 'value' as the button label.

Parameters

array

$data

Data to define the button:

name: (string) Button name.
value: (string) Button value.
label-message: (string, optional) Button label message key to use instead of 'value'. Overrides 'label' and 'label-raw'.
label: (string, optional) Button label text to use instead of 'value'. Overrides 'label-raw'.
label-raw: (string, optional) Button label HTML to use instead of 'value'.
id: (string, optional) DOM id for the button.
attribs: (array, optional) Additional HTML attributes.
flags: (string|string[], optional) OOUI flags.

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 899 of file HTMLForm.php.

References $args.

Referenced by SpecialBotPasswords\alterForm().

HTMLForm::addFooterText	(	$msg,
		$section = `null`
	)

Add footer text, inside the form.

Parameters

string	$msg	Complete text of message to display
string \| null	$section	The section to add the footer text to

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 769 of file HTMLForm.php.

References $section.

Referenced by UploadForm\__construct().

HTMLForm::addHeaderText	(	$msg,
		$section = `null`
	)

Add HTML to the header, inside the form.

Parameters

string	$msg	Additional HTML to display in header
string \| null	$section	The section to add the header to

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 714 of file HTMLForm.php.

References $section.

Referenced by SpecialBlock\alterForm(), SpecialChangeEmail\alterForm(), and UploadForm\getDescriptionSection().

HTMLForm::addHiddenField	(		$name,
			$value,
		array	$attribs = `[]`
	)

Add a hidden field to the output.

Parameters

string	$name	Field name. This will be used exactly as entered
string	$value	Field value
array	$attribs

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 851 of file HTMLForm.php.

References $attribs, $name, and $value.

Referenced by RevertAction\alterForm().

HTMLForm::addHiddenFields ( array $fields )

Add an array of hidden fields to the output.

Since: 1.22

Parameters

array $fields Associative array of fields to add; mapping names to their values

Returns: HTMLForm $this for chaining calls

Definition at line 868 of file HTMLForm.php.

References $name, $value, and as.

Referenced by SpecialChangeEmail\alterForm(), and SpecialPasswordReset\alterForm().

HTMLForm::addPostText ( $msg )

Add text to the end of the display.

Parameters

string $msg Complete text of message to display

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 823 of file HTMLForm.php.

HTMLForm::addPreText ( $msg )

Add HTML to introductory message.

Parameters

string $msg Complete HTML of message to display

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 700 of file HTMLForm.php.

Referenced by SpecialBotPasswords\alterForm().

HTMLForm::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.

Attention: You should call prepareForm() before calling this function. Moreover, when doing method chaining this should be the very last method call just after prepareForm().

Parameters

bool | string | array | Status $submitResult Output from HTMLForm::trySubmit()

Returns: void Nothing, should be last call

Definition at line 957 of file HTMLForm.php.

References getHTML(), and ContextSource\getOutput().

Referenced by show(), and showAlways().

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

Todo:: Document

Parameters

	array[]\|HTMLFormField[]	$fields Array of fields (either arrays or objects).
string	$sectionName	ID attribute of the "<table>" tag for this section, ignored if empty.
string	$fieldsetIDPrefix	ID prefix for the "<fieldset>" tag of each subsection, ignored if empty.
bool	&$hasUserVisibleFields	Whether the section had user-visible fields.

Exceptions

LogicException When called on uninitialized field data, e.g. When HTMLForm::displayForm was called without calling HTMLForm::prepareForm first.

Returns: string

Definition at line 1476 of file HTMLForm.php.

References $displayFormat, $html, $key, $retval, $section, $value, as, Sanitizer\escapeId(), formatSection(), getDisplayFormat(), getFooterText(), getHeaderText(), getLegend(), and wrapFieldSetSection().

Referenced by EditWatchlistNormalHTMLForm\getBody(), getBody(), and PreferencesForm\getBody().

static HTMLForm::factory ( $displayFormat )

static

Construct a HTMLForm object for given display type.

May return a HTMLForm subclass.

Parameters

string	$displayFormat
mixed	$arguments,...	Additional arguments to pass to the constructor.

Returns: HTMLForm

Definition at line 264 of file HTMLForm.php.

Referenced by SpecialExport\execute(), SpecialBlockList\execute(), SpecialPagesWithProp\execute(), SpecialComparePages\execute(), LinkSearchPage\execute(), FileDuplicateSearchPage\execute(), AuthManagerSpecialPage\getAuthForm(), LoginSignupSpecialPage\getAuthForm(), FormSpecialPage\getForm(), WithoutInterwikiPage\getPageHeader(), SpecialExpandTemplates\makeForm(), SpecialAllPages\outputHTMLForm(), EmailConfirmation\showRequestForm(), and SpecialUploadStash\showUploads().

HTMLForm::filterDataForSubmit ( $data )

Overload this if you want to apply special filtration routines to the form as a whole, after it's submitted but before it's processed.

Parameters

array $data

Returns: array

Definition at line 1648 of file HTMLForm.php.

Referenced by trySubmit().

HTMLForm::formatErrors ( $errors )

Format a stack of error messages into a single HTML string.

Parameters

array $errors Array of message keys/values

Returns: string HTML, a "<ul>" list of errors

Definition at line 1197 of file HTMLForm.php.

References as, getMessage(), and Html\rawElement().

Referenced by SpecialBlock\alterForm(), and getErrors().

HTMLForm::formatSection	(	array	$fieldsHtml,
			$sectionName,
			$anyFieldHasLabel
	)

protected

Put a form section together from the individual fields' HTML, merging it and wrapping.

Parameters

array	$fieldsHtml
string	$sectionName
bool	$anyFieldHasLabel

Returns: string HTML

Definition at line 1567 of file HTMLForm.php.

References $attribs, $html, Sanitizer\escapeId(), getDisplayFormat(), and Html\rawElement().

Referenced by displaySection().

HTMLForm::getAction ( )

Get the value for the action attribute of the form.

Since: 1.22

Returns: string

Definition at line 1687 of file HTMLForm.php.

References $mAction, ContextSource\getConfig(), getMethod(), getTitle(), and wfScript().

Referenced by getFormAttributes().

HTMLForm::getBody ( )

Get the whole body of the form.

Returns: string

Definition at line 1161 of file HTMLForm.php.

References displaySection().

Referenced by getHTML().

HTMLForm::getButtons ( )

Get the submit and (potentially) reset buttons.

Returns: string HTML.

Definition at line 1067 of file HTMLForm.php.

References $attribs, $mSubmitID, $mSubmitName, array(), as, Html\element(), ContextSource\getConfig(), getMessage(), ContextSource\getRequest(), getSubmitText(), ContextSource\msg(), Html\rawElement(), Xml\submitButton(), text, and Linker\tooltipAndAccesskeyAttribs().

Referenced by getHTML().

static HTMLForm::getClassFromDescriptor	(		$fieldname,
		&	$descriptor
	)

static

Get the HTMLFormField subclass for this descriptor.

The descriptor can be passed either 'class' which is the name of a HTMLFormField subclass, or a shorter 'type' which is an alias. This makes sure the 'class' is always set, and also is returned by this function for ease.

Since: 1.23

Parameters

string	$fieldname	Name of the field
array	$descriptor	Input Descriptor, as described above

Exceptions

MWException

Returns: string Name of a HTMLFormField subclass

Definition at line 421 of file HTMLForm.php.

HTMLForm::getDisplayFormat ( )

Getter for displayFormat.

Since: 1.20

Returns: string

Definition at line 390 of file HTMLForm.php.

References $displayFormat.

Referenced by displaySection(), formatSection(), and HTMLCheckField\getLabel().

HTMLForm::getErrors ( $errors )

Format and display an error message stack.

Parameters

string | array | Status $errors

Returns: string

Definition at line 1172 of file HTMLForm.php.

References formatErrors(), ContextSource\getOutput(), and Html\rawElement().

Referenced by getHTML().

HTMLForm::getFooterText ( $section = null )

Get footer text.

Parameters

string | null $section The section to get the footer text for

Since: 1.26

Returns: string

Definition at line 808 of file HTMLForm.php.

References $mFooter, and $section.

Referenced by displaySection(), and getHTML().

HTMLForm::getFormAttributes ( )

protected

Get HTML attributes for the <form> tag.

Returns: array

Definition at line 991 of file HTMLForm.php.

References $attribs, $mAutocomplete, $mId, $mName, getAction(), and getMethod().

Referenced by OOUIHTMLForm\wrapForm(), and wrapForm().

HTMLForm::getHeaderText ( $section = null )

Get header text.

Parameters

string | null $section The section to get the header text for

Since: 1.26

Returns: string HTML

Definition at line 753 of file HTMLForm.php.

References $mHeader, and $section.

Referenced by displaySection(), and getHTML().

HTMLForm::getHiddenFields ( )

Get the hidden fields that should go inside the form.

Returns: string HTML.

Definition at line 1039 of file HTMLForm.php.

References $attribs, $html, $value, as, ContextSource\getConfig(), getMethod(), getTitle(), ContextSource\getUser(), Html\hidden(), and list.

Referenced by getHTML().

HTMLForm::getHTML ( $submitResult )

Returns the raw HTML generated by the form.

Parameters

bool | string | array | Status $submitResult Output from HTMLForm::trySubmit()

Returns: string HTML

Definition at line 968 of file HTMLForm.php.

References $html, $mPost, getBody(), getButtons(), getErrors(), getFooterText(), getHeaderText(), getHiddenFields(), ContextSource\getOutput(), and wrapForm().

Referenced by displayForm().

HTMLForm::getLegend ( $key )

Get a string to go in the "<legend>" of a section fieldset.

Override this if you want something more complicated.

Parameters

string $key

Returns: string

Definition at line 1660 of file HTMLForm.php.

References ContextSource\msg().

Referenced by displaySection().

HTMLForm::getMessage ( $value )

protected

Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.

Parameters

mixed $value

Returns: Message

Definition at line 1728 of file HTMLForm.php.

References $value, and Message\newFromSpecifier().

Referenced by formatErrors(), OOUIHTMLForm\getButtons(), getButtons(), and OOUIHTMLForm\getErrors().

HTMLForm::getMethod ( )

Returns: string Always lowercase

Definition at line 1444 of file HTMLForm.php.

References $mMethod.

Referenced by getAction(), getFormAttributes(), getHiddenFields(), and tryAuthorizedSubmit().

HTMLForm::getSubmitText ( )

Get the text for the submit button, either customised or a default.

Returns: string

Definition at line 1263 of file HTMLForm.php.

References ContextSource\msg().

Referenced by OOUIHTMLForm\getButtons(), VFormHTMLForm\getButtons(), and getButtons().

HTMLForm::getTitle ( )

Get the title.

Returns: Title

Implements IContextSource.

Definition at line 1422 of file HTMLForm.php.

References $mTitle, and ContextSource\getContext().

Referenced by UploadForm\__construct(), getAction(), and getHiddenFields().

HTMLForm::isVForm ( )

Test if displayFormat is 'vform'.

Since: 1.22

Deprecated:

since 1.25

Returns: bool

Definition at line 400 of file HTMLForm.php.

References wfDeprecated().

HTMLForm::loadData ( )

Construct the form fields from the Descriptor array.

Definition at line 1603 of file HTMLForm.php.

References $name, $request, $value, as, and ContextSource\getRequest().

Referenced by prepareForm().

static HTMLForm::loadInputFromParameters	(		$fieldname,
			$descriptor,
		HTMLForm	$parent = `null`
	)

static

Initialise a new Object for the field.

Parameters

string	$fieldname	Name of the field
array	$descriptor	Input Descriptor, as described above
HTMLForm \| null	$parent	Parent instance of HTMLForm

Exceptions

MWException

Returns: HTMLFormField Instance of a subclass of HTMLFormField

Definition at line 449 of file HTMLForm.php.

Referenced by HTMLFormFieldCloner\createFieldsForKey(), ApiOptions\execute(), HTMLFormFieldCloner\getInputHTML(), HTMLFormFieldCloner\getInputHTMLForKey(), and Preferences\loadPreferenceValues().

HTMLForm::prepareForm ( )

Prepare form for submission.

Attention: When doing method chaining, that should be the very last method call before displayForm().

Exceptions

MWException

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 474 of file HTMLForm.php.

References loadData().

Referenced by show(), and showAlways().

HTMLForm::setAction ( $action )

Set the value for the action attribute of the form.

When set to false (which is the default state), the set title is used.

Since: 1.19

Parameters

string | bool $action

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1674 of file HTMLForm.php.

HTMLForm::setAutocomplete ( $autocomplete )

Set the value for the autocomplete attribute of the form.

When set to false (which is the default state), the attribute get not set.

Since: 1.27

Parameters

string | bool $autocomplete

Returns: HTMLForm $this for chaining calls

Definition at line 1716 of file HTMLForm.php.

HTMLForm::setDisplayFormat ( $format )

Set format in which to display the form.

Parameters

string $format The name of the format to use, must be one of $this->availableDisplayFormats

Exceptions

MWException

Since: 1.20

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 361 of file HTMLForm.php.

References ContextSource\getConfig().

HTMLForm::setFooterText	(	$msg,
		$section = `null`
	)

Set footer text, inside the form.

Since: 1.19

Parameters

string	$msg	Complete text of message to display
string \| null	$section	The section to add the footer text to

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 791 of file HTMLForm.php.

References $section.

HTMLForm::setHeaderText	(	$msg,
		$section = `null`
	)

Set header text, inside the form.

Since: 1.19

Parameters

string	$msg	Complete HTML of header to display
string \| null	$section	The section to add the header to

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 736 of file HTMLForm.php.

References $section.

Referenced by SpecialUnlockdb\alterForm(), SpecialLockdb\alterForm(), SpecialBlock\alterForm(), and SpecialPasswordReset\alterForm().

HTMLForm::setId ( $id )

Parameters

string $id DOM id for the form

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1339 of file HTMLForm.php.

Referenced by UploadForm\__construct(), SpecialChangeEmail\alterForm(), and SpecialBotPasswords\alterForm().

HTMLForm::setIntro ( $msg )

Set the introductory message, overwriting any existing message.

Parameters

string $msg Complete text of message to display

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 673 of file HTMLForm.php.

References setPreText().

HTMLForm::setMessagePrefix ( $p )

Set the prefix for various default messages.

Todo:: Currently only used for the "<fieldset>" legend on forms with multiple sections; should be used elsewhere?

Parameters

string $p

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1399 of file HTMLForm.php.

HTMLForm::setMethod ( $method = 'post' )

Set the method used to submit the form.

Parameters

string $method

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1435 of file HTMLForm.php.

Referenced by SpecialChangeContentModel\alterForm(), and SpecialRedirect\alterForm().

HTMLForm::setName ( $name )

Parameters

string $name 'name' attribute for the form

Returns: HTMLForm $this for chaining calls

Definition at line 1349 of file HTMLForm.php.

References $name.

HTMLForm::setPostText ( $msg )

Set text at the end of the display.

Parameters

string $msg Complete text of message to display

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 836 of file HTMLForm.php.

HTMLForm::setPreText ( $msg )

Set the introductory message HTML, overwriting any existing message.

Since: 1.19

Parameters

string $msg Complete HTML of message to display

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 687 of file HTMLForm.php.

Referenced by setIntro().

HTMLForm::setSubmitCallback ( $cb )

Set a callback to a function to do something with the form once it's been successfully validated.

Parameters

callable $cb The function will be passed the output from HTMLForm::filterDataForSubmit and this HTMLForm object, and must return as documented for HTMLForm::trySubmit

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 646 of file HTMLForm.php.

HTMLForm::setSubmitDestructive ( )

Identify that the submit button in the form has a destructive action.

Since: 1.24

Definition at line 1230 of file HTMLForm.php.

Referenced by SpecialBlock\alterForm().

HTMLForm::setSubmitID ( $t )

Set the id for the submit button.

Parameters

string $t

Todo:

FIXME: Integrity of $t is not validated

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1297 of file HTMLForm.php.

References $t.

HTMLForm::setSubmitName ( $name )

Parameters

string $name Submit button name

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1272 of file HTMLForm.php.

References $name.

Referenced by UploadForm\__construct().

HTMLForm::setSubmitProgressive ( )

Identify that the submit button in the form has a progressive action.

Since: 1.25

Definition at line 1238 of file HTMLForm.php.

HTMLForm::setSubmitText ( $t )

Set the text for the submit button.

Parameters

string $t Plaintext

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1220 of file HTMLForm.php.

References $t.

Referenced by UploadForm\__construct(), and setSubmitTextMsg().

HTMLForm::setSubmitTextMsg ( $msg )

Set the text for the submit button to a message.

Since: 1.19

Parameters

string | Message $msg Message key or Message object

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1250 of file HTMLForm.php.

References ContextSource\msg(), and setSubmitText().

Referenced by SpecialChangeContentModel\alterForm(), UnwatchAction\alterForm(), WatchAction\alterForm(), SpecialUnlockdb\alterForm(), SpecialLockdb\alterForm(), RevertAction\alterForm(), PurgeAction\alterForm(), SpecialRandomInCategory\alterForm(), SpecialBlock\alterForm(), SpecialPageLanguage\alterForm(), SpecialChangeEmail\alterForm(), SpecialPasswordReset\alterForm(), SpecialResetTokens\alterForm(), and SpecialRedirect\alterForm().

HTMLForm::setSubmitTooltip ( $name )

Parameters

string $name Tooltip for the submit button

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1283 of file HTMLForm.php.

References $name.

Referenced by UploadForm\__construct().

HTMLForm::setTableId ( $id )

Set the id of the \<table\> or outermost \<div\> element.

Since: 1.22

Parameters

string $id New value of the id attribute, or "" to remove

Returns: HTMLForm $this for chaining calls

Definition at line 1328 of file HTMLForm.php.

Referenced by SpecialChangeEmail\alterForm(), and SpecialBotPasswords\alterForm().

HTMLForm::setTitle ( $t )

Set the title for form submission.

Parameters

Title $t Title of page the form is on/should be posted to

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1412 of file HTMLForm.php.

References $t.

HTMLForm::setTokenSalt ( $salt )

Set the salt for the edit token.

Only useful when the method is "post".

Since: 1.24

Parameters

string | array $salt Salt to use

Returns: HTMLForm $this For chaining calls

Definition at line 939 of file HTMLForm.php.

Referenced by WatchAction\alterForm(), and RevertAction\alterForm().

HTMLForm::setValidationErrorMessage ( $msg )

Set a message to display on a validation error.

Parameters

string | array $msg String or Array of valid inputs to wfMessage() (so each entry can be either a String or Array)

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 660 of file HTMLForm.php.

HTMLForm::setWrapperLegend ( $legend )

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

Parameters

string | bool $legend If false, no wrapper or legend will be displayed. If true, a wrapper will be displayed, but no legend. If a string, a wrapper will be displayed with that string as a legend. The string will be escaped before being output (this doesn't support HTML).

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1366 of file HTMLForm.php.

Referenced by SpecialUnlockdb\alterForm(), SpecialLockdb\alterForm(), and setWrapperLegendMsg().

HTMLForm::setWrapperLegendMsg ( $msg )

Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.

Since: 1.19

Parameters

string | Message $msg Message key or Message object

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1381 of file HTMLForm.php.

References ContextSource\msg(), and setWrapperLegend().

Referenced by RevertAction\alterForm(), SpecialBlock\alterForm(), and SpecialBotPasswords\alterForm().

HTMLForm::show ( )

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

Returns: bool|Status Whether submission was successful.

Definition at line 522 of file HTMLForm.php.

References displayForm(), prepareForm(), and tryAuthorizedSubmit().

HTMLForm::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.

Returns: bool|Status Whether submission was successful.

Definition at line 540 of file HTMLForm.php.

References displayForm(), prepareForm(), and tryAuthorizedSubmit().

HTMLForm::suppressDefaultSubmit ( $suppressSubmit = true )

Stop a default submit button being shown for this form.

This implies that an alternate submit method must be provided manually.

Since: 1.22

Parameters

bool $suppressSubmit Set to false to re-enable the button again

Returns: HTMLForm $this for chaining calls

Definition at line 1313 of file HTMLForm.php.

Referenced by SpecialResetTokens\alterForm(), and SpecialBotPasswords\alterForm().

HTMLForm::suppressReset ( $suppressReset = true )

Stop a reset button being shown for this form.

Parameters

bool $suppressReset Set to false to re-enable the button again

Returns: HTMLForm $this for chaining calls (since 1.20)

Definition at line 1633 of file HTMLForm.php.

HTMLForm::tryAuthorizedSubmit ( )

Try submitting, with edit token check first.

Returns: Status|bool

Definition at line 490 of file HTMLForm.php.

References getMethod(), ContextSource\getRequest(), ContextSource\getUser(), and trySubmit().

Referenced by show(), and showAlways().

HTMLForm::trySubmit ( )

Validate all the fields, and call the submission callback function if everything is kosher.

Exceptions

MWException

Returns

bool|string|array|Status

Bool true or a good Status object indicates success,
Bool false indicates no submission was attempted,
Anything else indicates failure. The value may be a fatal Status object, an HTML string, or an array of arrays (message keys and params) or strings (message keys)

Definition at line 561 of file HTMLForm.php.

References $mSubmitCallback, $res, as, and filterDataForSubmit().

Referenced by tryAuthorizedSubmit().

HTMLForm::wasSubmitted ( )

Test whether the form was considered to have been submitted or not, i.e.

whether the last call to tryAuthorizedSubmit or trySubmit returned non-false.

This will return false until HTMLForm::tryAuthorizedSubmit or HTMLForm::trySubmit is called.

Since: 1.23

Returns: bool

Definition at line 632 of file HTMLForm.php.

References $mWasSubmitted.

HTMLForm::wrapFieldSetSection	(	$legend,
		$section,
		$attributes
	)

protected

Wraps the given $section into an user-visible fieldset.

Parameters

string	$legend	Legend text for the fieldset
string	$section	The section content in plain Html
array	$attributes	Additional attributes for the fieldset

Returns: string The fieldset's Html

Definition at line 1456 of file HTMLForm.php.

References $section, and Xml\fieldset().

Referenced by displaySection().

HTMLForm::wrapForm ( $html )

Wrap the form innards in an actual "<form>" element.

Parameters

string $html HTML contents to wrap.

Returns: string Wrapped HTML.

Definition at line 1021 of file HTMLForm.php.

References $html, Xml\fieldset(), getFormAttributes(), and Html\rawElement().

Referenced by getHTML().

Member Data Documentation

array HTMLForm::$availableDisplayFormats

protected

Initial value:

= [
        'table',
        'div',
        'raw',
        'inline',
    ]

Available formats in which to display the form.

Definition at line 241 of file HTMLForm.php.

array HTMLForm::$availableSubclassDisplayFormats

protected

Initial value:

= [
        'vform',
        'ooui',
    ]

Available formats in which to display the form.

Definition at line 252 of file HTMLForm.php.

string HTMLForm::$displayFormat = 'table'

protected

Format in which to display form.

For viable options,

See also: $availableDisplayFormats

Definition at line 235 of file HTMLForm.php.

Referenced by displaySection(), and getDisplayFormat().

bool string HTMLForm::$mAction = false

protected

Form action URL.

false means we will use the URL to set Title

Since: 1.19

Definition at line 200 of file HTMLForm.php.

Referenced by getAction().

bool string HTMLForm::$mAutocomplete = false

protected

Form attribute autocomplete.

false does not set the attribute

Since: 1.27

Definition at line 207 of file HTMLForm.php.

Referenced by getFormAttributes().

HTMLForm::$mButtons = []

protected

Definition at line 211 of file HTMLForm.php.

HTMLForm::$mFieldData

Definition at line 127 of file HTMLForm.php.

HTMLForm::$mFieldTree

protected

Definition at line 168 of file HTMLForm.php.

HTMLFormField [] HTMLForm::$mFlatFields

protected

Definition at line 166 of file HTMLForm.php.

HTMLForm::$mFooter = ''

protected

Definition at line 178 of file HTMLForm.php.

Referenced by getFooterText().

HTMLForm::$mHeader = ''

protected

Definition at line 177 of file HTMLForm.php.

Referenced by getHeaderText().

HTMLForm::$mHiddenFields = []

protected

Definition at line 210 of file HTMLForm.php.

HTMLForm::$mId

protected

Definition at line 182 of file HTMLForm.php.

Referenced by getFormAttributes().

HTMLForm::$mMessagePrefix

protected

Definition at line 163 of file HTMLForm.php.

HTMLForm::$mMethod = 'post'

protected

Definition at line 192 of file HTMLForm.php.

Referenced by getMethod().

HTMLForm::$mName

protected

Definition at line 183 of file HTMLForm.php.

Referenced by getFormAttributes().

HTMLForm::$mPost = ''

protected

Definition at line 181 of file HTMLForm.php.

Referenced by getHTML().

HTMLForm::$mPre = ''

protected

Definition at line 176 of file HTMLForm.php.

HTMLForm::$mSectionFooters = []

protected

Definition at line 180 of file HTMLForm.php.

HTMLForm::$mSectionHeaders = []

protected

Definition at line 179 of file HTMLForm.php.

HTMLForm::$mShowReset = false

protected

Definition at line 169 of file HTMLForm.php.

HTMLForm::$mShowSubmit = true

protected

Definition at line 170 of file HTMLForm.php.

HTMLForm::$mSubmitCallback

protected

Definition at line 173 of file HTMLForm.php.

Referenced by trySubmit().

HTMLForm::$mSubmitFlags = [ 'constructive', 'primary' ]

protected

Definition at line 171 of file HTMLForm.php.

Referenced by OOUIHTMLForm\getButtons().

HTMLForm::$mSubmitID

protected

Definition at line 186 of file HTMLForm.php.

Referenced by OOUIHTMLForm\getButtons(), VFormHTMLForm\getButtons(), and getButtons().

HTMLForm::$mSubmitName

protected

Definition at line 187 of file HTMLForm.php.

Referenced by OOUIHTMLForm\getButtons(), VFormHTMLForm\getButtons(), and getButtons().

HTMLForm::$mSubmitText

protected

Definition at line 188 of file HTMLForm.php.

HTMLForm::$mSubmitTooltip

protected

Definition at line 189 of file HTMLForm.php.

HTMLForm::$mSubSectionBeforeFields = true

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.

Definition at line 228 of file HTMLForm.php.

HTMLForm::$mTableId = ''

protected

Definition at line 184 of file HTMLForm.php.

HTMLForm::$mTitle

protected

Definition at line 191 of file HTMLForm.php.

Referenced by getTitle().

string array HTMLForm::$mTokenSalt = ''

protected

Salt for the edit token.

Definition at line 219 of file HTMLForm.php.

HTMLForm::$mUseMultipart = false

protected

Definition at line 209 of file HTMLForm.php.

HTMLForm::$mValidationErrorMessage

protected

Definition at line 174 of file HTMLForm.php.

HTMLForm::$mWasSubmitted = false

protected

Definition at line 193 of file HTMLForm.php.

Referenced by wasSubmitted().

HTMLForm::$mWrapperLegend = false

protected

Definition at line 213 of file HTMLForm.php.

Referenced by OOUIHTMLForm\formatSection().

HTMLForm::$typeMappings

static

Initial value:

= [

'api' => 'HTMLApiField'

Definition at line 125 of file HTMLForm.php.

Referenced by AuthManagerSpecialPage\addTabIndex().

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

includes/htmlform/HTMLForm.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation