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

Inheritance diagram for HTMLForm:

[legend]

Collaboration diagram for HTMLForm:

[legend]

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

	addFields ( $descriptor)
	Add fields 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...

	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 ()

	getPreText ()
	Get the introductory message HTML. More...

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

	setCollapsibleOptions ( $collapsedByDefault=false)
	Enable collapsible mode, and set whether the form is collapsed by default. 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)

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

	setWrapperAttributes ( $attributes)
	For internal use only. 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,... $params)
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)

Static Public Member Functions
static	factory ( $displayFormat,... $arguments)
	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, $isRoot)
	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...

array[]	$mButtons = []
	-var array<array{name:string,value:string,label-message?:string,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string\|string[],framed?:bool}> More...

	$mCancelTarget

bool	$mCollapsed = false
	Whether the form is collapsed by default. More...

bool	$mCollapsible = false
	Whether the form can be collapsed. More...

	$mFieldTree = []

HTMLFormField[]	$mFlatFields = []

	$mFooter = ''

	$mFormIdentifier

	$mHeader = ''

	$mHiddenFields = []

	$mId

	$mMessagePrefix

	$mMethod = 'post'

	$mName

	$mPost = ''

	$mPre = ''

	$mSectionFooters = []

	$mSectionHeaders = []

	$mShowCancel = false

	$mShowReset = false

	$mShowSubmit = true

	$mSubmitCallback

string[]	$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

	$mWrapperAttributes = []

	$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 'nodata' – if set (to any value, which casts to true), the data for this field will not be loaded from the actual request. Instead, always the default data is set as the value of this field. 'id' – HTML id attribute 'cssclass' – CSS class 'csshelpclass' – CSS class used to style help text 'dir' – Direction of the element. 'options' – associative array mapping raw text labels to values. Some field types support multi-level arrays. Overwrites 'options-message'. 'options-messages' – associative array mapping message keys to values. Some field types support multi-level arrays. Overwrites 'options' and 'options-message'. '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'. 'help-inline' – Whether help text (defined using options above) will be shown inline after the input field, rather than in a popup. Defaults to true. Only used by OOUI form fields. '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 131 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	$descriptor	Array of Field constructs, as described in the class documentation
IContextSource \| null	$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

Reimplemented in OOUIHTMLForm.

Definition at line 325 of file HTMLForm.php.

References ContextSource\$context, addFields(), 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

$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.
framed: (boolean=true, optional) OOUI framed attribute.

-param array{name:string,value:string,label-message?:string,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string|string[],framed?:bool} $data

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

Definition at line 991 of file HTMLForm.php.

References $args.

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

◆ addFields()

HTMLForm::addFields ( $descriptor )

Add fields to the form.

Since: 1.34

Parameters

array $descriptor Array of Field constructs, as described in the class documentation

Returns: HTMLForm

Definition at line 360 of file HTMLForm.php.

Referenced by __construct().

◆ addFooterText()

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

Referenced by UploadForm\__construct().

◆ addHeaderText()

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

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

◆ addHiddenField()

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

Referenced by McrRestoreAction\addStatePropagationFields(), McrUndoAction\addStatePropagationFields(), RollbackAction\alterForm(), RevertAction\alterForm(), and MarkpatrolledAction\alterForm().

◆ addHiddenFields()

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

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

◆ addPostText()

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

◆ addPreText()

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 777 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 $submitResult Output from HTMLForm::trySubmit()

Returns: void Nothing, should be last call

Reimplemented in MediaWiki\Extension\OATHAuth\HTMLForm\OATHAuthOOUIHTMLForm.

Definition at line 1050 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[]	$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

Reimplemented in EditWatchlistNormalHTMLForm.

Definition at line 1671 of file HTMLForm.php.

References $displayFormat, formatSection(), getDisplayFormat(), getFooterText(), getHeaderText(), getLegend(), and wrapFieldSetSection().

Referenced by PreferencesFormOOUI\getBody(), and getBody().

◆ factory()

static HTMLForm::factory	(	$displayFormat,
		$arguments
	)

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

References $displayFormat.

Referenced by SpecialActiveUsers\buildForm(), SpecialNewFiles\buildForm(), SpecialBookSources\buildForm(), SpecialAllMessages\execute(), SpecialAutoblockList\execute(), SpecialExport\execute(), SpecialUnblock\execute(), SpecialBlockList\execute(), SpecialComparePages\execute(), SpecialLinkSearch\execute(), SpecialPagesWithProp\execute(), SpecialFileDuplicateSearch\execute(), CategoryTreePage\executeInputForm(), SpecialNewpages\form(), AuthManagerSpecialPage\getAuthForm(), LoginSignupSpecialPage\getAuthForm(), FormAction\getForm(), FormSpecialPage\getForm(), SpecialContributions\getForm(), ImageListPager\getForm(), SpecialWithoutInterwiki\getPageHeader(), SpecialMIMESearch\getPageHeader(), UsersPager\getPageHeader(), CategoryPager\getStartForm(), SpecialExpandTemplates\makeForm(), SpecialPrefixindex\namespacePrefixForm(), HistoryAction\onView(), SpecialAllPages\outputHTMLForm(), SpecialTags\processCreateTagForm(), SpecialNuke\promptForm(), SpecialEmailUser\sendEmailForm(), SpecialTags\showActivateDeactivateForm(), SpecialTags\showDeleteTagForm(), SpecialGadgets\showExportForm(), SpecialNewSection\showForm(), SpecialPermanentLink\showForm(), SpecialDiff\showForm(), SpecialInterwiki\showForm(), SpecialProtectedpages\showOptions(), LogEventsList\showOptions(), SpecialProtectedtitles\showOptions(), SpecialConfirmEmail\showRequestForm(), SpecialPreferences\showResetForm(), SpecialTags\showTagList(), SpecialUploadStash\showUploads(), and SpecialEmailUser\userForm().

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

Definition at line 1851 of file HTMLForm.php.

Referenced by trySubmit().

◆ formatErrors()

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

References getMessage().

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

References $displayFormat, and getDisplayFormat().

Referenced by displaySection().

◆ getAction()

HTMLForm::getAction ( )

Get the value for the action attribute of the form.

Since: 1.22

Returns: string

Definition at line 1890 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 OOUIHTMLForm, and PreferencesFormOOUI.

Definition at line 1294 of file HTMLForm.php.

References displaySection().

Referenced by getHTML().

◆ getButtons()

HTMLForm::getButtons ( )

Get the submit and (potentially) reset buttons.

Returns: string HTML.

Reimplemented in PreferencesFormOOUI, VFormHTMLForm, and OOUIHTMLForm.

Definition at line 1185 of file HTMLForm.php.

References $mSubmitID, $mSubmitName, ContextSource\getConfig(), getMessage(), ContextSource\getRequest(), getSubmitText(), ContextSource\msg(), Title\newMainPage(), Xml\submitButton(), and Linker\tooltipAndAccesskeyAttribs().

Referenced by getHTML().

◆ 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	$fieldname	Name of the field
array	&$descriptor	Input Descriptor, as described in the class documentation

Exceptions

MWException

Returns: string Name of a HTMLFormField subclass

Definition at line 479 of file HTMLForm.php.

◆ getDisplayFormat()

HTMLForm::getDisplayFormat ( )

Getter for displayFormat.

Since: 1.20

Returns: string

Definition at line 458 of file HTMLForm.php.

References $displayFormat.

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

◆ getErrorsOrWarnings()

HTMLForm::getErrorsOrWarnings	(	$elements,
		$elementsType
	)

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

Parameters

string \| array \| Status	$elements	The set of errors/warnings to process.
string	$elementsType	Should 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 1306 of file HTMLForm.php.

References $status, formatErrors(), and ContextSource\getOutput().

Referenced by getHTML().

◆ getField()

HTMLForm::getField ( $fieldname )

Parameters

string $fieldname

Returns: HTMLFormField

Exceptions

DomainException on invalid field name

Definition at line 406 of file HTMLForm.php.

References hasField().

◆ getFooterText()

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

References $mFooter.

Referenced by displaySection(), PreferencesFormOOUI\getBody(), and getHTML().

◆ getFormAttributes()

HTMLForm::getFormAttributes ( )

protected

Get HTML attributes for the <form> tag.

Returns: array

Reimplemented in VFormHTMLForm.

Definition at line 1099 of file HTMLForm.php.

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

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

◆ getHeaderText()

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

Reimplemented in OOUIHTMLForm.

Definition at line 841 of file HTMLForm.php.

References $mHeader.

Referenced by displaySection(), and getHTML().

◆ getHiddenFields()

HTMLForm::getHiddenFields ( )

Get the hidden fields that should go inside the form.

Returns: string HTML.

Definition at line 1151 of file HTMLForm.php.

References ContextSource\getConfig(), getMethod(), getTitle(), and ContextSource\getUser().

Referenced by getHTML().

◆ 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; -taint escaped

Reimplemented in VFormHTMLForm, and MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm.

Definition at line 1062 of file HTMLForm.php.

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

Referenced by MediaWiki\Extension\OATHAuth\HTMLForm\OATHAuthOOUIHTMLForm\displayForm(), and 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 Plain text (not HTML-escaped)

Reimplemented in EditWatchlistNormalHTMLForm, and PreferencesFormOOUI.

Definition at line 1863 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 1931 of file HTMLForm.php.

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

◆ getMethod()

HTMLForm::getMethod ( )

Returns: string Always lowercase

Definition at line 1638 of file HTMLForm.php.

References $mMethod.

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

◆ getPreText()

HTMLForm::getPreText ( )

Get the introductory message HTML.

Since: 1.32

Returns: string

Definition at line 790 of file HTMLForm.php.

References $mPre.

◆ getSubmitText()

HTMLForm::getSubmitText ( )

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

Returns: string

Definition at line 1401 of file HTMLForm.php.

References ContextSource\msg().

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

◆ getTitle()

HTMLForm::getTitle ( )

Get the title.

Returns: Title

Reimplemented from ContextSource.

Definition at line 1616 of file HTMLForm.php.

References $mTitle, and ContextSource\getContext().

Referenced by UploadForm\__construct(), getAction(), PreferencesFormOOUI\getButtons(), getHiddenFields(), and MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

◆ hasField()

HTMLForm::hasField ( $fieldname )

Parameters

string $fieldname

Returns: bool

Definition at line 397 of file HTMLForm.php.

Referenced by getField().

◆ loadData()

HTMLForm::loadData ( )

Construct the form fields from the Descriptor array.

Definition at line 1806 of file HTMLForm.php.

References ContextSource\getRequest().

Referenced by prepareForm().

◆ loadInputFromParameters()

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 in the class documentation
HTMLForm \| null	$parent	Parent instance of HTMLForm

Exceptions

MWException

Returns: HTMLFormField Instance of a subclass of HTMLFormField

Reimplemented in OOUIHTMLForm, and VFormHTMLForm.

Definition at line 508 of file HTMLForm.php.

Referenced by HTMLFormFieldCloner\createFieldsForKey(), ApiOptions\execute(), HTMLFormFieldCloner\getCreateButtonHtml(), HTMLFormFieldCloner\getDeleteButtonHtml(), 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 1944 of file HTMLForm.php.

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 533 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 1877 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 1919 of file HTMLForm.php.

◆ setCancelTarget()

HTMLForm::setCancelTarget ( $target )

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

Parameters

Title | string $target Target as a Title object or an URL

Returns: HTMLForm $this for chaining calls

Since: 1.27

Definition at line 1495 of file HTMLForm.php.

Referenced by McrUndoAction\alterForm().

◆ setCollapsibleOptions()

HTMLForm::setCollapsibleOptions ( $collapsedByDefault = false )

Enable collapsible mode, and set whether the form is collapsed by default.

Since: 1.34

Parameters

bool $collapsedByDefault Whether the form is collapsed by default (optional).

Returns: HTMLForm $this for chaining calls

Definition at line 1089 of file HTMLForm.php.

◆ setDisplayFormat()

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

References ContextSource\getConfig().

◆ setFooterText()

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

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

◆ setHeaderText()

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

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

◆ setId()

HTMLForm::setId ( $id )

Parameters

string $id DOM id for the form

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

Definition at line 1520 of file HTMLForm.php.

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

◆ setIntro()

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

Referenced by MediaWiki\Extension\OATHAuth\Special\DisableOATHForUser\alterForm().

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

Referenced by SpecialCiteThisPage\alterForm(), 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 1530 of file HTMLForm.php.

◆ setPostText()

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

◆ setPreText()

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

Referenced by MediaWiki\Extension\OATHAuth\Special\DisableOATHForUser\alterForm(), and 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 $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 723 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 1374 of file HTMLForm.php.

Referenced by SpecialPasswordReset\alterForm(), SpecialBlock\alterForm(), and SpecialResetTokens\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 1435 of file HTMLForm.php.

References $t.

◆ setSubmitName()

HTMLForm::setSubmitName ( $name )

Parameters

string $name Submit button name

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

Definition at line 1410 of file HTMLForm.php.

Referenced by UploadForm\__construct(), and McrUndoAction\alterForm().

◆ setSubmitText()

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

References $t.

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

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

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

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

◆ setSubmitTooltip()

HTMLForm::setSubmitTooltip ( $name )

Parameters

string $name Tooltip for the submit button

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

Definition at line 1421 of file HTMLForm.php.

Referenced by UploadForm\__construct(), and McrUndoAction\alterForm().

◆ setTableId()

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

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

◆ setTitle()

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 1606 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 $salt Salt to use

Returns: HTMLForm $this For chaining calls

Definition at line 1032 of file HTMLForm.php.

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

◆ setValidationErrorMessage()

HTMLForm::setValidationErrorMessage ( $msg )

Set a message to display on a validation error.

Parameters

array $msg Array of valid inputs to wfMessage() (so each entry must itself be an array of arguments)

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

Definition at line 737 of file HTMLForm.php.

◆ setWrapperAttributes()

HTMLForm::setWrapperAttributes ( $attributes )

For internal use only.

Use is discouraged, and should only be used where support for gadgets/user scripts is warranted.

Parameters

array $attributes

Definition at line 1560 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 $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 1547 of file HTMLForm.php.

Referenced by MediaWiki\Extension\OATHAuth\Special\DisableOATHForUser\alterForm(), SpecialUnlockdb\alterForm(), SpecialLockdb\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 $msg Message key or Message object

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

Definition at line 1575 of file HTMLForm.php.

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

Referenced by McrRestoreAction\alterForm(), UnwatchAction\alterForm(), RollbackAction\alterForm(), WatchAction\alterForm(), RevertAction\alterForm(), PurgeAction\alterForm(), SpecialBotPasswords\alterForm(), and McrUndoAction\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 594 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 612 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 1484 of file HTMLForm.php.

Referenced by McrUndoAction\alterForm().

◆ 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 $suppressSubmit Set to false to re-enable the button again

Returns: HTMLForm $this for chaining calls

Definition at line 1472 of file HTMLForm.php.

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

◆ suppressReset()

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

◆ tryAuthorizedSubmit()

HTMLForm::tryAuthorizedSubmit ( )

Try submitting, with edit token check first.

Returns: Status|bool

Definition at line 556 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 633 of file HTMLForm.php.

References $mSubmitCallback, $res, 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 709 of file HTMLForm.php.

References $mWasSubmitted.

◆ wrapFieldSetSection()

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

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
bool	$isRoot	Section is at the root of the tree

Returns: string The fieldset's Html

Reimplemented in PreferencesFormOOUI, OOUIHTMLForm, and MediaWiki\Extension\OATHAuth\HTMLForm\OATHAuthOOUIHTMLForm.

Definition at line 1651 of file HTMLForm.php.

References Xml\fieldset().

Referenced by displaySection().

◆ wrapForm()

HTMLForm::wrapForm ( $html )

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

Parameters

string $html HTML contents to wrap.

Returns: string Wrapped HTML.

Reimplemented in OOUIHTMLForm, PreferencesFormOOUI, and VFormHTMLForm.

Definition at line 1133 of file HTMLForm.php.

References Xml\fieldset(), and getFormAttributes().

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

◆ $availableSubclassDisplayFormats

array HTMLForm::$availableSubclassDisplayFormats

protected

Initial value:

= [
        'vform',
        'ooui',
    ]

Available formats in which to display the form.

Definition at line 291 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 274 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 220 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 241 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mButtons

array [] HTMLForm::$mButtons = []

protected

-var array<array{name:string,value:string,label-message?:string,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string|string[],framed?:bool}>

Definition at line 249 of file HTMLForm.php.

◆ $mCancelTarget

HTMLForm::$mCancelTarget

protected

Definition at line 190 of file HTMLForm.php.

◆ $mCollapsed

bool HTMLForm::$mCollapsed = false

protected

Whether the form is collapsed by default.

Since: 1.34

Definition at line 234 of file HTMLForm.php.

◆ $mCollapsible

bool HTMLForm::$mCollapsible = false

protected

Whether the form can be collapsed.

Since: 1.34

Definition at line 227 of file HTMLForm.php.

◆ $mFieldData

HTMLForm::$mFieldData

Definition at line 178 of file HTMLForm.php.

◆ $mFieldTree

HTMLForm::$mFieldTree = []

protected

Definition at line 184 of file HTMLForm.php.

◆ $mFlatFields

HTMLFormField [] HTMLForm::$mFlatFields = []

protected

Definition at line 183 of file HTMLForm.php.

◆ $mFooter

HTMLForm::$mFooter = ''

protected

Definition at line 197 of file HTMLForm.php.

Referenced by getFooterText().

◆ $mFormIdentifier

HTMLForm::$mFormIdentifier

protected

Definition at line 210 of file HTMLForm.php.

Referenced by tryAuthorizedSubmit().

◆ $mHeader

HTMLForm::$mHeader = ''

protected

Definition at line 196 of file HTMLForm.php.

Referenced by getHeaderText().

◆ $mHiddenFields

HTMLForm::$mHiddenFields = []

protected

Definition at line 244 of file HTMLForm.php.

◆ $mId

HTMLForm::$mId

protected

Definition at line 201 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mMessagePrefix

HTMLForm::$mMessagePrefix

protected

Definition at line 180 of file HTMLForm.php.

◆ $mMethod

HTMLForm::$mMethod = 'post'

protected

Definition at line 212 of file HTMLForm.php.

Referenced by getMethod().

◆ $mName

HTMLForm::$mName

protected

Definition at line 202 of file HTMLForm.php.

Referenced by getFormAttributes().

◆ $mPost

HTMLForm::$mPost = ''

protected

Definition at line 200 of file HTMLForm.php.

Referenced by getHTML().

◆ $mPre

HTMLForm::$mPre = ''

protected

Definition at line 195 of file HTMLForm.php.

Referenced by getPreText().

◆ $mSectionFooters

HTMLForm::$mSectionFooters = []

protected

Definition at line 199 of file HTMLForm.php.

◆ $mSectionHeaders

HTMLForm::$mSectionHeaders = []

protected

Definition at line 198 of file HTMLForm.php.

◆ $mShowCancel

HTMLForm::$mShowCancel = false

protected

Definition at line 189 of file HTMLForm.php.

◆ $mShowReset

HTMLForm::$mShowReset = false

protected

Definition at line 185 of file HTMLForm.php.

◆ $mShowSubmit

HTMLForm::$mShowSubmit = true

protected

Definition at line 186 of file HTMLForm.php.

◆ $mSubmitCallback

HTMLForm::$mSubmitCallback

protected

Definition at line 192 of file HTMLForm.php.

Referenced by trySubmit().

◆ $mSubmitFlags

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

protected

Definition at line 188 of file HTMLForm.php.

Referenced by OOUIHTMLForm\getButtons().

◆ $mSubmitID

HTMLForm::$mSubmitID

protected

Definition at line 205 of file HTMLForm.php.

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

◆ $mSubmitName

HTMLForm::$mSubmitName

protected

Definition at line 206 of file HTMLForm.php.

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

◆ $mSubmitText

HTMLForm::$mSubmitText

protected

Definition at line 207 of file HTMLForm.php.

◆ $mSubmitTooltip

HTMLForm::$mSubmitTooltip

protected

Definition at line 208 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 267 of file HTMLForm.php.

◆ $mTableId

HTMLForm::$mTableId = ''

protected

Definition at line 203 of file HTMLForm.php.

◆ $mTitle

HTMLForm::$mTitle

protected

Definition at line 211 of file HTMLForm.php.

Referenced by getTitle().

◆ $mTokenSalt

string array HTMLForm::$mTokenSalt = ''

protected

Salt for the edit token.

Definition at line 258 of file HTMLForm.php.

◆ $mUseMultipart

HTMLForm::$mUseMultipart = false

protected

Definition at line 243 of file HTMLForm.php.

◆ $mValidationErrorMessage

HTMLForm::$mValidationErrorMessage

protected

Definition at line 193 of file HTMLForm.php.

◆ $mWasSubmitted

HTMLForm::$mWasSubmitted = false

protected

Definition at line 213 of file HTMLForm.php.

Referenced by wasSubmitted().

◆ $mWrapperAttributes

HTMLForm::$mWrapperAttributes = []

protected

Definition at line 252 of file HTMLForm.php.

◆ $mWrapperLegend

HTMLForm::$mWrapperLegend = false

protected

Definition at line 251 of file HTMLForm.php.

◆ $typeMappings

HTMLForm::$typeMappings

static

Definition at line 133 of file HTMLForm.php.

Referenced by AuthManagerSpecialPage\addTabIndex(), and HTMLExpiryField\getFieldByType().

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

◆ __construct()

Member Function Documentation

◆ addButton()

◆ addFields()

◆ addFooterText()

◆ addHeaderText()

◆ addHiddenField()

◆ addHiddenFields()

◆ addPostText()

◆ addPreText()

◆ displayForm()

◆ displaySection()

◆ factory()

◆ filterDataForSubmit()

◆ formatErrors()

◆ formatSection()

◆ getAction()

◆ getBody()

◆ getButtons()

◆ getClassFromDescriptor()

◆ getDisplayFormat()

◆ getErrorsOrWarnings()

◆ getField()

◆ getFooterText()

◆ getFormAttributes()

◆ getHeaderText()

◆ getHiddenFields()

◆ getHTML()

◆ getLegend()

◆ getMessage()

◆ getMethod()

◆ getPreText()

◆ getSubmitText()

◆ getTitle()

◆ hasField()

◆ loadData()

◆ loadInputFromParameters()

◆ needsJSForHtml5FormValidation()

◆ prepareForm()

◆ setAction()

◆ setAutocomplete()

◆ setCancelTarget()

◆ setCollapsibleOptions()

◆ setDisplayFormat()

◆ setFooterText()

◆ setFormIdentifier()

◆ setHeaderText()

◆ setId()

◆ setIntro()

◆ setMessagePrefix()

◆ setMethod()

◆ setName()

◆ setPostText()

◆ setPreText()

◆ setSubmitCallback()

◆ setSubmitDestructive()

◆ setSubmitID()

◆ setSubmitName()

◆ setSubmitText()

◆ setSubmitTextMsg()

◆ setSubmitTooltip()

◆ setTableId()

◆ setTitle()

◆ setTokenSalt()

◆ setValidationErrorMessage()

◆ setWrapperAttributes()

◆ setWrapperLegend()

◆ setWrapperLegendMsg()

◆ show()

◆ showAlways()

◆ showCancel()

◆ suppressDefaultSubmit()