MediaWiki  REL1_31
HTMLForm Class Reference

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...
 
 getErrorsOrWarnings ( $elements, $elementsType)
 Returns a formatted list of errors or warnings from the given elements. More...
 
 getField ( $fieldname)
 
 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...
 
 hasField ( $fieldname)
 
 loadData ()
 Construct the form fields from the Descriptor array. More...
 
 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. 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...
 
 setCancelTarget ( $target)
 Sets the target where the user is redirected to after clicking cancel. More...
 
 setDisplayFormat ( $format)
 Set format in which to display the form. More...
 
 setFooterText ( $msg, $section=null)
 Set footer text, inside the form. More...
 
 setFormIdentifier ( $ident)
 Set an internal identifier for this 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...
 
 showCancel ( $show=true)
 Show a cancel button (or prevent it). 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

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

 $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...
 
string null $mAutocomplete = null
 Form attribute autocomplete. More...
 
 $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. 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'. 'notice' – message text for a message to use as a notice in the field. Currently used by OOUI form fields only. 'notice-messages' – array of message keys/objects to use for notice. Overrides 'notice'. 'notice-message' – message key or object to use as a notice. '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 130 of file HTMLForm.php.

Constructor & Destructor Documentation

◆ __construct()

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

Build a new HTMLForm from an array of field attributes.

Parameters
array$descriptorArray of Field constructs, as described above
IContextSource$contextAvailable since 1.18, will become compulsory in 1.18. Obviates the need to call $form->setTitle()
string$messagePrefixA prefix to go in front of default messages

Reimplemented in OOUIHTMLForm.

Definition at line 304 of file HTMLForm.php.

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

Member Function Documentation

◆ addButton()

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$dataData 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.
  • framed: (boolean=true, optional) OOUI framed attribute.
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 947 of file HTMLForm.php.

References $args.

Referenced by SpecialBotPasswords\alterForm().

◆ addFooterText()

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

Add footer text, inside the form.

Parameters
string$msgComplete text of message to display
string | null$sectionThe section to add the footer text to
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 816 of file HTMLForm.php.

References $section.

Referenced by UploadForm\__construct().

◆ addHeaderText()

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

Add HTML to the header, inside the form.

Parameters
string$msgAdditional HTML to display in header
string | null$sectionThe section to add the header to
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 761 of file HTMLForm.php.

References $section.

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

◆ addHiddenField()

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

Add a hidden field to the output.

Parameters
string$nameField name. This will be used exactly as entered
string$valueField value
array$attribs
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 898 of file HTMLForm.php.

References $attribs, $name, and $value.

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

◆ addHiddenFields()

HTMLForm::addHiddenFields ( array  $fields)

Add an array of hidden fields to the output.

Since
1.22
Parameters
array$fieldsAssociative array of fields to add; mapping names to their values
Returns
HTMLForm $this for chaining calls

Definition at line 915 of file HTMLForm.php.

References $name, $value, and as.

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

◆ addPostText()

HTMLForm::addPostText (   $msg)

Add text to the end of the display.

Parameters
string$msgComplete text of message to display
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 870 of file HTMLForm.php.

◆ addPreText()

HTMLForm::addPreText (   $msg)

Add HTML to introductory message.

Parameters
string$msgComplete HTML of message to display
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 747 of file HTMLForm.php.

Referenced by SpecialBotPasswords\alterForm().

◆ displayForm()

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.

Warning
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$submitResultOutput from HTMLForm::trySubmit()
Returns
void Nothing, should be last call

Definition at line 1006 of file HTMLForm.php.

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

Referenced by show(), and showAlways().

◆ displaySection()

HTMLForm::displaySection (   $fields,
  $sectionName = '',
  $fieldsetIDPrefix = '',
$hasUserVisibleFields = false 
)
Todo:
Document
Parameters
array[] | HTMLFormField[]$fieldsArray of fields (either arrays or objects).
string$sectionNameID attribute of the "<table>" tag for this section, ignored if empty.
string$fieldsetIDPrefixID prefix for the "<fieldset>" tag of each subsection, ignored if empty.
bool&$hasUserVisibleFieldsWhether the section had user-visible fields.
Exceptions
LogicExceptionWhen called on uninitialized field data, e.g. When HTMLForm::displayForm was called without calling HTMLForm::prepareForm first.
Returns
string

Definition at line 1625 of file HTMLForm.php.

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

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

◆ factory()

◆ filterDataForSubmit()

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

Reimplemented in PreferencesForm.

Definition at line 1803 of file HTMLForm.php.

Referenced by trySubmit().

◆ formatErrors()

HTMLForm::formatErrors (   $errors)

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

Parameters
array$errorsArray of message keys/values
Returns
string HTML, a "<ul>" list of errors

Definition at line 1295 of file HTMLForm.php.

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

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

◆ formatSection()

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

Reimplemented in OOUIHTMLForm.

Definition at line 1716 of file HTMLForm.php.

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

Referenced by displaySection().

◆ getAction()

HTMLForm::getAction ( )

Get the value for the action attribute of the form.

Since
1.22
Returns
string

Definition at line 1842 of file HTMLForm.php.

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

Referenced by getFormAttributes().

◆ getBody()

HTMLForm::getBody ( )

Get the whole body of the form.

Returns
string

Reimplemented in PreferencesForm, EditWatchlistNormalHTMLForm, and OOUIHTMLForm.

Definition at line 1236 of file HTMLForm.php.

References displaySection().

Referenced by getHTML().

◆ getButtons()

HTMLForm::getButtons ( )

◆ getClassFromDescriptor()

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$fieldnameName of the field
array&$descriptorInput Descriptor, as described above
Exceptions
MWException
Returns
string Name of a HTMLFormField subclass

Definition at line 449 of file HTMLForm.php.

◆ getDisplayFormat()

HTMLForm::getDisplayFormat ( )

Getter for displayFormat.

Since
1.20
Returns
string

Definition at line 429 of file HTMLForm.php.

References $displayFormat.

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

◆ getErrors()

HTMLForm::getErrors (   $errors)

Format and display an error message stack.

Parameters
string | array | Status$errors
Deprecated:
since 1.28, use getErrorsOrWarnings() instead
Returns
string

Definition at line 1249 of file HTMLForm.php.

References getErrorsOrWarnings(), and wfDeprecated().

◆ getErrorsOrWarnings()

HTMLForm::getErrorsOrWarnings (   $elements,
  $elementsType 
)

Returns a formatted list of errors or warnings from the given elements.

Parameters
string | array | Status$elementsThe set of errors/warnings to process.
string$elementsTypeShould warnings or errors be returned. This is meant for Status objects, all other valid types are always considered as errors.
Returns
string

Reimplemented in OOUIHTMLForm.

Definition at line 1262 of file HTMLForm.php.

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

Referenced by getErrors(), and getHTML().

◆ getField()

HTMLForm::getField (   $fieldname)
Parameters
string$fieldname
Returns
HTMLFormField
Exceptions
DomainExceptionon invalid field name

Definition at line 377 of file HTMLForm.php.

References hasField().

◆ getFooterText()

HTMLForm::getFooterText (   $section = null)

Get footer text.

Parameters
string | null$sectionThe section to get the footer text for
Since
1.26
Returns
string

Definition at line 855 of file HTMLForm.php.

References $mFooter, and $section.

Referenced by displaySection(), and getHTML().

◆ getFormAttributes()

HTMLForm::getFormAttributes ( )
protected

Get HTML attributes for the <form> tag.

Returns
array

Reimplemented in VFormHTMLForm.

Definition at line 1041 of file HTMLForm.php.

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

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

◆ getHeaderText()

HTMLForm::getHeaderText (   $section = null)

Get header text.

Parameters
string | null$sectionThe section to get the header text for
Since
1.26
Returns
string HTML

Reimplemented in OOUIHTMLForm.

Definition at line 800 of file HTMLForm.php.

References $mHeader, and $section.

Referenced by displaySection(), and getHTML().

◆ getHiddenFields()

HTMLForm::getHiddenFields ( )

Get the hidden fields that should go inside the form.

Returns
string HTML.

Definition at line 1093 of file HTMLForm.php.

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

Referenced by getHTML().

◆ getHTML()

HTMLForm::getHTML (   $submitResult)

Returns the raw HTML generated by the form.

Parameters
bool | string | array | Status$submitResultOutput from HTMLForm::trySubmit()
Returns
string HTML

Reimplemented in VFormHTMLForm.

Definition at line 1017 of file HTMLForm.php.

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

Referenced by displayForm().

◆ getLegend()

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

Reimplemented in EditWatchlistNormalHTMLForm, and PreferencesForm.

Definition at line 1815 of file HTMLForm.php.

References ContextSource\msg().

Referenced by displaySection().

◆ getMessage()

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 1883 of file HTMLForm.php.

References $value, and Message\newFromSpecifier().

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

◆ getMethod()

HTMLForm::getMethod ( )
Returns
string Always lowercase

Definition at line 1593 of file HTMLForm.php.

References $mMethod.

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

◆ getSubmitText()

HTMLForm::getSubmitText ( )

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

Returns
string

Definition at line 1369 of file HTMLForm.php.

References ContextSource\msg().

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

◆ getTitle()

HTMLForm::getTitle ( )

◆ hasField()

HTMLForm::hasField (   $fieldname)
Parameters
string$fieldname
Returns
bool

Definition at line 368 of file HTMLForm.php.

Referenced by getField().

◆ loadData()

HTMLForm::loadData ( )

Construct the form fields from the Descriptor array.

Definition at line 1758 of file HTMLForm.php.

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

Referenced by prepareForm().

◆ loadInputFromParameters()

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

Initialise a new Object for the field.

Parameters
string$fieldnameName of the field
array$descriptorInput Descriptor, as described above
HTMLForm | null$parentParent instance of HTMLForm
Exceptions
MWException
Returns
HTMLFormField Instance of a subclass of HTMLFormField

Reimplemented in VFormHTMLForm, and OOUIHTMLForm.

Definition at line 477 of file HTMLForm.php.

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

◆ needsJSForHtml5FormValidation()

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

If this function returns true, a 'novalidate' attribute will be added on the <form> element. It will be removed if the user agent has JavaScript support, in htmlform.js.

Returns
bool
Since
1.29

Definition at line 1896 of file HTMLForm.php.

References as.

Referenced by getFormAttributes().

◆ prepareForm()

HTMLForm::prepareForm ( )

Prepare form for submission.

Warning
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 502 of file HTMLForm.php.

References ContextSource\getRequest(), and loadData().

Referenced by show(), and showAlways().

◆ setAction()

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 1829 of file HTMLForm.php.

◆ setAutocomplete()

HTMLForm::setAutocomplete (   $autocomplete)

Set the value for the autocomplete attribute of the form.

A typical value is "off". When set to null (which is the default state), the attribute get not set.

Since
1.27
Parameters
string | null$autocomplete
Returns
HTMLForm $this for chaining calls

Definition at line 1871 of file HTMLForm.php.

◆ setCancelTarget()

HTMLForm::setCancelTarget (   $target)

Sets the target where the user is redirected to after clicking cancel.

Parameters
Title | string$targetTarget as a Title object or an URL
Returns
HTMLForm $this for chaining calls
Since
1.27

Definition at line 1463 of file HTMLForm.php.

◆ setDisplayFormat()

HTMLForm::setDisplayFormat (   $format)

Set format in which to display the form.

Parameters
string$formatThe 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 394 of file HTMLForm.php.

References ContextSource\getConfig().

◆ setFooterText()

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

Set footer text, inside the form.

Since
1.19
Parameters
string$msgComplete text of message to display
string | null$sectionThe section to add the footer text to
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 838 of file HTMLForm.php.

References $section.

◆ setFormIdentifier()

HTMLForm::setFormIdentifier (   $ident)

Set an internal identifier for this form.

It will be submitted as a hidden form field, allowing HTMLForm to determine whether the form was submitted (or merely viewed). Setting this serves two purposes:

  • If you use two or more forms on one page, it allows HTMLForm to identify which of the forms was submitted, and not attempt to validate the other ones.
  • If you use checkbox or multiselect fields inside a form using the GET method, it allows HTMLForm to distinguish between the initial page view and a form submission with all checkboxes or select options unchecked.
Since
1.28
Parameters
string$ident
Returns
$this

Definition at line 1424 of file HTMLForm.php.

◆ setHeaderText()

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

Set header text, inside the form.

Since
1.19
Parameters
string$msgComplete HTML of header to display
string | null$sectionThe section to add the header to
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 783 of file HTMLForm.php.

References $section.

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

◆ setId()

HTMLForm::setId (   $id)
Parameters
string$idDOM id for the form
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1488 of file HTMLForm.php.

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

◆ setIntro()

HTMLForm::setIntro (   $msg)

Set the introductory message, overwriting any existing message.

Parameters
string$msgComplete text of message to display
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 720 of file HTMLForm.php.

References setPreText().

◆ setMessagePrefix()

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 1548 of file HTMLForm.php.

◆ setMethod()

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 1584 of file HTMLForm.php.

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

◆ setName()

HTMLForm::setName (   $name)
Parameters
string$name'name' attribute for the form
Returns
HTMLForm $this for chaining calls

Definition at line 1498 of file HTMLForm.php.

References $name.

◆ setPostText()

HTMLForm::setPostText (   $msg)

Set text at the end of the display.

Parameters
string$msgComplete text of message to display
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 883 of file HTMLForm.php.

◆ setPreText()

HTMLForm::setPreText (   $msg)

Set the introductory message HTML, overwriting any existing message.

Since
1.19
Parameters
string$msgComplete HTML of message to display
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 734 of file HTMLForm.php.

Referenced by setIntro().

◆ setSubmitCallback()

HTMLForm::setSubmitCallback (   $cb)

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

Parameters
callable$cbThe 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 693 of file HTMLForm.php.

◆ setSubmitDestructive()

HTMLForm::setSubmitDestructive ( )

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

Since
1.24
Returns
HTMLForm $this for chaining calls (since 1.28)

Definition at line 1330 of file HTMLForm.php.

Referenced by SpecialBlock\alterForm().

◆ setSubmitID()

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 1403 of file HTMLForm.php.

References $t.

◆ setSubmitName()

HTMLForm::setSubmitName (   $name)
Parameters
string$nameSubmit button name
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1378 of file HTMLForm.php.

References $name.

Referenced by UploadForm\__construct().

◆ setSubmitProgressive()

HTMLForm::setSubmitProgressive ( )

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

Since
1.25
Returns
HTMLForm $this for chaining calls (since 1.28)

Definition at line 1342 of file HTMLForm.php.

◆ setSubmitText()

HTMLForm::setSubmitText (   $t)

Set the text for the submit button.

Parameters
string$tPlaintext
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1318 of file HTMLForm.php.

References $t.

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

◆ setSubmitTextMsg()

◆ setSubmitTooltip()

HTMLForm::setSubmitTooltip (   $name)
Parameters
string$nameTooltip for the submit button
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1389 of file HTMLForm.php.

References $name.

Referenced by UploadForm\__construct().

◆ setTableId()

HTMLForm::setTableId (   $id)

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

Since
1.22
Parameters
string$idNew value of the id attribute, or "" to remove
Returns
HTMLForm $this for chaining calls

Definition at line 1477 of file HTMLForm.php.

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

◆ setTitle()

HTMLForm::setTitle (   $t)

Set the title for form submission.

Parameters
Title$tTitle of page the form is on/should be posted to
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1561 of file HTMLForm.php.

References $t.

◆ setTokenSalt()

HTMLForm::setTokenSalt (   $salt)

Set the salt for the edit token.

Only useful when the method is "post".

Since
1.24
Parameters
string | array$saltSalt to use
Returns
HTMLForm $this For chaining calls

Definition at line 988 of file HTMLForm.php.

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

◆ setValidationErrorMessage()

HTMLForm::setValidationErrorMessage (   $msg)

Set a message to display on a validation error.

Parameters
string | array$msgString 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 707 of file HTMLForm.php.

◆ setWrapperLegend()

HTMLForm::setWrapperLegend (   $legend)

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

Parameters
string | bool$legendIf 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 1515 of file HTMLForm.php.

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

◆ 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$msgMessage key or Message object
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1530 of file HTMLForm.php.

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

Referenced by PurgeAction\alterForm(), RevertAction\alterForm(), UnwatchAction\alterForm(), WatchAction\alterForm(), and SpecialBotPasswords\alterForm().

◆ show()

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.

Reimplemented in UploadForm.

Definition at line 564 of file HTMLForm.php.

References displayForm(), StatusValue\isGood(), prepareForm(), and tryAuthorizedSubmit().

◆ showAlways()

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 582 of file HTMLForm.php.

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

◆ showCancel()

HTMLForm::showCancel (   $show = true)

Show a cancel button (or prevent it).

The button is not shown by default.

Parameters
bool$show
Returns
HTMLForm $this for chaining calls
Since
1.27

Definition at line 1452 of file HTMLForm.php.

◆ suppressDefaultSubmit()

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$suppressSubmitSet to false to re-enable the button again
Returns
HTMLForm $this for chaining calls

Definition at line 1440 of file HTMLForm.php.

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

◆ suppressReset()

HTMLForm::suppressReset (   $suppressReset = true)

Stop a reset button being shown for this form.

Parameters
bool$suppressResetSet to false to re-enable the button again
Returns
HTMLForm $this for chaining calls (since 1.20)

Definition at line 1788 of file HTMLForm.php.

◆ tryAuthorizedSubmit()

HTMLForm::tryAuthorizedSubmit ( )

Try submitting, with edit token check first.

Returns
Status|bool

Definition at line 525 of file HTMLForm.php.

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

Referenced by show(), and showAlways().

◆ trySubmit()

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)

Reimplemented in UploadForm.

Definition at line 603 of file HTMLForm.php.

References $mSubmitCallback, $res, array(), as, filterDataForSubmit(), and StatusValue\newGood().

Referenced by tryAuthorizedSubmit().

◆ wasSubmitted()

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 679 of file HTMLForm.php.

References $mWasSubmitted.

◆ wrapFieldSetSection()

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

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

Parameters
string$legendLegend text for the fieldset
string$sectionThe section content in plain Html
array$attributesAdditional attributes for the fieldset
Returns
string The fieldset's Html

Reimplemented in OOUIHTMLForm.

Definition at line 1605 of file HTMLForm.php.

References $section, and Xml\fieldset().

Referenced by displaySection().

◆ wrapForm()

HTMLForm::wrapForm (   $html)

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

Parameters
string$htmlHTML contents to wrap.
Returns
string Wrapped HTML.

Reimplemented in PreferencesForm, VFormHTMLForm, and OOUIHTMLForm.

Definition at line 1075 of file HTMLForm.php.

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

Referenced by getHTML().

Member Data Documentation

◆ $availableDisplayFormats

array HTMLForm::$availableDisplayFormats
protected
Initial value:
= [
'table',
'div',
'raw',
'inline',
]

Available formats in which to display the form.

Definition at line 256 of file HTMLForm.php.

◆ $availableSubclassDisplayFormats

array HTMLForm::$availableSubclassDisplayFormats
protected
Initial value:
= [
'vform',
'ooui',
]

Available formats in which to display the form.

Definition at line 267 of file HTMLForm.php.

◆ $displayFormat

string HTMLForm::$displayFormat = 'table'
protected

Format in which to display form.

For viable options,

See also
$availableDisplayFormats

Definition at line 250 of file HTMLForm.php.

Referenced by displaySection(), factory(), formatSection(), and getDisplayFormat().

◆ $mAction

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 215 of file HTMLForm.php.

Referenced by getAction().

◆ $mAutocomplete

string null HTMLForm::$mAutocomplete = null
protected

Form attribute autocomplete.

A typical value is "off". null does not set the attribute

Since
1.27

Definition at line 222 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mButtons

HTMLForm::$mButtons = []
protected

Definition at line 226 of file HTMLForm.php.

◆ $mCancelTarget

HTMLForm::$mCancelTarget
protected

Definition at line 185 of file HTMLForm.php.

◆ $mFieldData

HTMLForm::$mFieldData

Definition at line 173 of file HTMLForm.php.

◆ $mFieldTree

HTMLForm::$mFieldTree
protected

Definition at line 180 of file HTMLForm.php.

◆ $mFlatFields

HTMLFormField [] HTMLForm::$mFlatFields
protected

Definition at line 178 of file HTMLForm.php.

◆ $mFooter

HTMLForm::$mFooter = ''
protected

Definition at line 192 of file HTMLForm.php.

Referenced by getFooterText().

◆ $mFormIdentifier

HTMLForm::$mFormIdentifier
protected

Definition at line 205 of file HTMLForm.php.

Referenced by tryAuthorizedSubmit().

◆ $mHeader

HTMLForm::$mHeader = ''
protected

Definition at line 191 of file HTMLForm.php.

Referenced by getHeaderText().

◆ $mHiddenFields

HTMLForm::$mHiddenFields = []
protected

Definition at line 225 of file HTMLForm.php.

◆ $mId

HTMLForm::$mId
protected

Definition at line 196 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mMessagePrefix

HTMLForm::$mMessagePrefix
protected

Definition at line 175 of file HTMLForm.php.

◆ $mMethod

HTMLForm::$mMethod = 'post'
protected

Definition at line 207 of file HTMLForm.php.

Referenced by getMethod().

◆ $mName

HTMLForm::$mName
protected

Definition at line 197 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mPost

HTMLForm::$mPost = ''
protected

Definition at line 195 of file HTMLForm.php.

Referenced by getHTML().

◆ $mPre

HTMLForm::$mPre = ''
protected

Definition at line 190 of file HTMLForm.php.

◆ $mSectionFooters

HTMLForm::$mSectionFooters = []
protected

Definition at line 194 of file HTMLForm.php.

◆ $mSectionHeaders

HTMLForm::$mSectionHeaders = []
protected

Definition at line 193 of file HTMLForm.php.

◆ $mShowCancel

HTMLForm::$mShowCancel = false
protected

Definition at line 184 of file HTMLForm.php.

◆ $mShowReset

HTMLForm::$mShowReset = false
protected

Definition at line 181 of file HTMLForm.php.

◆ $mShowSubmit

HTMLForm::$mShowSubmit = true
protected

Definition at line 182 of file HTMLForm.php.

◆ $mSubmitCallback

HTMLForm::$mSubmitCallback
protected

Definition at line 187 of file HTMLForm.php.

Referenced by trySubmit().

◆ $mSubmitFlags

HTMLForm::$mSubmitFlags = [ 'primary', 'progressive' ]
protected

Definition at line 183 of file HTMLForm.php.

Referenced by OOUIHTMLForm\getButtons().

◆ $mSubmitID

HTMLForm::$mSubmitID
protected

Definition at line 200 of file HTMLForm.php.

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

◆ $mSubmitName

HTMLForm::$mSubmitName
protected

Definition at line 201 of file HTMLForm.php.

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

◆ $mSubmitText

HTMLForm::$mSubmitText
protected

Definition at line 202 of file HTMLForm.php.

◆ $mSubmitTooltip

HTMLForm::$mSubmitTooltip
protected

Definition at line 203 of file HTMLForm.php.

◆ $mSubSectionBeforeFields

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 243 of file HTMLForm.php.

◆ $mTableId

HTMLForm::$mTableId = ''
protected

Definition at line 198 of file HTMLForm.php.

◆ $mTitle

HTMLForm::$mTitle
protected

Definition at line 206 of file HTMLForm.php.

Referenced by getTitle().

◆ $mTokenSalt

string array HTMLForm::$mTokenSalt = ''
protected

Salt for the edit token.

Definition at line 234 of file HTMLForm.php.

◆ $mUseMultipart

HTMLForm::$mUseMultipart = false
protected

Definition at line 224 of file HTMLForm.php.

◆ $mValidationErrorMessage

HTMLForm::$mValidationErrorMessage
protected

Definition at line 188 of file HTMLForm.php.

◆ $mWasSubmitted

HTMLForm::$mWasSubmitted = false
protected

Definition at line 208 of file HTMLForm.php.

Referenced by wasSubmitted().

◆ $mWrapperLegend

HTMLForm::$mWrapperLegend = false
protected

Definition at line 228 of file HTMLForm.php.

◆ $typeMappings

HTMLForm::$typeMappings
static

Definition at line 132 of file HTMLForm.php.

Referenced by AuthManagerSpecialPage\addTabIndex().


The documentation for this class was generated from the following file:
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130