The parent class to generate form fields. More...

Collaboration diagram for MediaWiki\HTMLForm\HTMLFormField:

[legend]

Public Member Functions
	__construct ( $params)
	Initialise the object.

	cancelSubmit ( $value, $alldata)
	Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

	canDisplayErrors ()
	True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

	filter ( $value, $alldata)

	getAttributes (array $list)
	Returns the given attributes from the parameters.

	getCodex ( $value)
	Get the Codex version of the div.

	getDefault ()

	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever.

	getErrorsAndErrorClass ( $value)
	Determine form errors to display and their classes.

	getErrorsRaw ( $value)
	Determine form errors to display, returning them in an array.

	getHelpText ()
	Determine the help text to display.

	getHelpTextHtmlDiv ( $helptext, $cssClasses=[])
	Generate help text HTML in div format.

	getHelpTextHtmlRaw ( $helptext)
	Generate help text HTML formatted for raw output.

	getHelpTextHtmlTable ( $helptext)
	Generate help text HTML in table format.

	getInline ( $value)
	Get the complete field as an inline element.

	getInputCodex ( $value, $hasErrors)
	Same as getInputHTML, but for Codex.

	getInputHTML ( $value)
	This function must be implemented to return the HTML to generate the input object itself.

	getInputOOUI ( $value)
	Same as getInputHTML, but returns an OOUI object.

	getLabel ()

	getLabelHtml ( $cellAttributes=[])

	getName ()
	Get the field name that will be used for submission.

	getOOUI ( $value)
	Get the OOUI version of the div.

	getOptions ()
	Fetch the array of options from the field's parameters.

	getOptionsOOUI ()
	Get options and make them into arrays suitable for OOUI.

	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever.

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.

	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

	getTooltipAndAccessKeyOOUI ()
	Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

	getVForm ( $value)
	Get the complete field for the input, including help text, labels, and whatever.

	hasVisibleOutput ()
	If this field has a user-visible output or not.

	isDisabled ( $alldata)
	Test whether this field is supposed to be disabled, based on the values of the other form fields.

	isHelpInline ()
	Determine if the help text should be displayed inline.

	isHidden ( $alldata)
	Test whether this field is supposed to be hidden, based on the values of the other form fields.

	loadDataFromRequest ( $request)
	Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

	msg ( $key,... $params)
	Get a translated interface message.

	needsJSForHtml5FormValidation ()
	Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank.

	skipLoadData ( $request)
	Skip this field when collecting data.

	validate ( $value, $alldata)
	Override this function to add specific validation checks on the field input.

Static Public Member Functions
static	flattenOptions ( $options)
	flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".

static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Public Attributes
array array[]	$mParams

HTMLForm null	$mParent

Protected Member Functions
	checkStateRecurse (array $alldata, array $params)
	Helper function for isHidden and isDisabled to handle recursive data structures.

	escapeLabel ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	getClassName ()
	Gets the non namespaced class name.

	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.

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

	getNearestField ( $name, $backCompat=false)
	Get the closest field matching a given name.

	getNearestFieldByName ( $alldata, $name, $asDisplay=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

	makeLabelSnippet ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?

	parseCondState ( $params)
	Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.

	parseCondStateForClient ()
	Parse the cond-state array for client-side.

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

	validateCondState ( $params)
	Validate the cond-state params, the existence check of fields should be done later.

Static Protected Member Functions
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Protected Attributes
string	$mClass = ''

array	$mCondState = []
	Array to hold params for 'hide-if' or 'disable-if' statements.

array	$mCondStateClass = []

mixed	$mDefault

string	$mDir

string false	$mHelpClass = false

string	$mID

string	$mLabel
	String label, as HTML.

string	$mName

array null false	$mOptions = false

bool	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.

string	$mVFormClass = ''

Detailed Description

The parent class to generate form fields.

Any field type should be a subclass of this.

Stability: stable: to extend

Definition at line 27 of file HTMLFormField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\HTMLFormField::__construct ( $params )

Initialise the object.

Stability: stable: to call

Parameters

array $params Associative Array. See HTMLForm doc for syntax.

Since: 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead

Definition at line 549 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getMessage(), MediaWiki\HTMLForm\HTMLFormField\validateCondState(), and wfDeprecatedMsg().

Member Function Documentation

◆ cancelSubmit()

MediaWiki\HTMLForm\HTMLFormField::cancelSubmit	(		$value,
			$alldata )

Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

Stability: stable: to override

Since: 1.23

Parameters

string \| array	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: bool True to cancel the submission

Reimplemented in MediaWiki\HTMLForm\Field\HTMLFormFieldCloner.

Definition at line 424 of file HTMLFormField.php.

◆ canDisplayErrors()

MediaWiki\HTMLForm\HTMLFormField::canDisplayErrors ( )

True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\HTMLForm\Field\HTMLHiddenField.

Definition at line 124 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\hasVisibleOutput().

◆ checkStateRecurse()

MediaWiki\HTMLForm\HTMLFormField::checkStateRecurse	(	array	$alldata,
		array	$params )

protected

Helper function for isHidden and isDisabled to handle recursive data structures.

Parameters

array	$alldata
array	$params

Returns: bool

Definition at line 306 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\checkStateRecurse(), and MediaWiki\HTMLForm\HTMLFormField\getNearestFieldValue().

Referenced by MediaWiki\HTMLForm\HTMLFormField\checkStateRecurse(), MediaWiki\HTMLForm\HTMLFormField\isDisabled(), and MediaWiki\HTMLForm\HTMLFormField\isHidden().

◆ escapeLabel()

MediaWiki\HTMLForm\HTMLFormField::escapeLabel ( $label )

protected

The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

Convert such a key to HTML.

FIXME: a dangerous and untidy convention.

Parameters

string $label

Returns: string

Definition at line 1477 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLRadioField\formatOptions(), MediaWiki\HTMLForm\Field\HTMLRadioField\getInputCodex(), and MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getOneCheckbox().

◆ filter()

MediaWiki\HTMLForm\HTMLFormField::filter	(		$value,
			$alldata )

Stability: stable: to override

Parameters

mixed	$value
mixed[]	$alldata

Returns: mixed

Definition at line 475 of file HTMLFormField.php.

◆ flattenOptions()

static MediaWiki\HTMLForm\HTMLFormField::flattenOptions ( $options )

static

flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".

Parameters

array $options Associative Array with values either Strings or Arrays

Returns: array Flattened input

Definition at line 1381 of file HTMLFormField.php.

◆ forceToStringRecursive()

static MediaWiki\HTMLForm\HTMLFormField::forceToStringRecursive ( $array )

static

Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Parameters

array | string $array

Returns: array|string

Definition at line 1323 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLMultiSelectField\filterDataForSubmit(), and MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getInputHTML().

◆ formatErrors()

static MediaWiki\HTMLForm\HTMLFormField::formatErrors ( $errors )

staticprotected

Formats one or more errors as accepted by field validation-callback.

Parameters

string | Message | array $errors Array of strings or Message instances To work around limitations in phan-taint-check the calling class has taintedness disabled. So instead we pretend that this method outputs html, since the result is eventually outputted anyways without escaping and this allows us to verify stuff is safe even though the caller has taintedness cleared.

Returns: string HTML

Since: 1.18

Definition at line 1408 of file HTMLFormField.php.

References MediaWiki\Message\Message\parse().

◆ getAttributes()

MediaWiki\HTMLForm\HTMLFormField::getAttributes ( array $list )

Returns the given attributes from the parameters.

Stability: stable: to override

Parameters

array $list List of attributes to get

Returns: array Attributes

Reimplemented in MediaWiki\HTMLForm\Field\HTMLAutoCompleteSelectField, MediaWiki\HTMLForm\Field\HTMLComboboxField, and MediaWiki\HTMLForm\Field\HTMLDateTimeField.

Definition at line 1265 of file HTMLFormField.php.

◆ getClassName()

MediaWiki\HTMLForm\HTMLFormField::getClassName ( )

protected

Gets the non namespaced class name.

Since: 1.36

Returns: string

Definition at line 919 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getOOUI(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getCodex()

MediaWiki\HTMLForm\HTMLFormField::getCodex ( $value )

Get the Codex version of the div.

Since: 1.42

Parameters

string $value The value to set the input to.

Returns: string HTML

Reimplemented in MediaWiki\HTMLForm\Field\HTMLHiddenField, and MediaWiki\HTMLForm\Field\HTMLInfoField.

Definition at line 836 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mClass, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\getErrorsAndErrorClass(), MediaWiki\HTMLForm\HTMLFormField\getHelpText(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlDiv(), MediaWiki\HTMLForm\HTMLFormField\getInputCodex(), MediaWiki\HTMLForm\HTMLFormField\getLabel(), MediaWiki\HTMLForm\HTMLFormField\isHidden(), MediaWiki\HTMLForm\HTMLFormField\needsLabel(), and MediaWiki\HTMLForm\HTMLFormField\parseCondStateForClient().

Referenced by MediaWiki\HTMLForm\CodexHTMLForm\formatField().

◆ getDefault()

MediaWiki\HTMLForm\HTMLFormField::getDefault ( )

Stability: stable: to override

Returns: mixed

Reimplemented in MediaWiki\HTMLForm\Field\HTMLCheckField, MediaWiki\HTMLForm\Field\HTMLCheckMatrix, MediaWiki\HTMLForm\Field\HTMLFormFieldCloner, MediaWiki\HTMLForm\Field\HTMLInfoField, MediaWiki\HTMLForm\Field\HTMLMultiSelectField, MediaWiki\HTMLForm\Field\HTMLRestrictionsField, and MediaWiki\HTMLForm\Field\HTMLSelectAndOtherField.

Definition at line 1225 of file HTMLFormField.php.

◆ getDiv()

MediaWiki\HTMLForm\HTMLFormField::getDiv ( $value )

Get the complete div for the input, including help text, labels, and whatever.

Stability: stable: to override

Since: 1.20

Parameters

string $value The value to set the input to.

Returns: string Complete HTML table row.

Reimplemented in MediaWiki\HTMLForm\Field\HTMLApiField, MediaWiki\HTMLForm\Field\HTMLEditTools, MediaWiki\HTMLForm\Field\HTMLHiddenField, MediaWiki\HTMLForm\Field\HTMLInfoField, and MediaWiki\HTMLForm\Field\HTMLTagFilter.

Definition at line 701 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLForm\formatField(), MediaWiki\HTMLForm\HTMLFormField\getOOUI(), and MediaWiki\HTMLForm\HTMLFormField\getVForm().

◆ getErrorsAndErrorClass()

MediaWiki\HTMLForm\HTMLFormField::getErrorsAndErrorClass ( $value )

Determine form errors to display and their classes.

Since: 1.20

phan-taint-check gets confused with returning both classes and errors and thinks double escaping is happening, so specify that return value has no taint.

Parameters

string $value The value of the input

Returns: array [ $errors, $errorClass ]

Definition at line 1143 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getInline(), MediaWiki\HTMLForm\HTMLFormField\getRaw(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getErrorsRaw()

MediaWiki\HTMLForm\HTMLFormField::getErrorsRaw ( $value )

Determine form errors to display, returning them in an array.

Since: 1.26

Parameters

string $value The value of the input

Returns: string[] Array of error HTML strings

Definition at line 1160 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getFieldLayoutOOUI()

MediaWiki\HTMLForm\HTMLFormField::getFieldLayoutOOUI	(		$inputField,
			$config )

protected

Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

Parameters

\\OOUI\\Widget	$inputField
array	$config

Returns: \OOUI\FieldLayout

Reimplemented in MediaWiki\HTMLForm\Field\HTMLSelectNamespaceWithButton, and MediaWiki\HTMLForm\Field\HTMLTextFieldWithButton.

Definition at line 939 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getHelpText()

MediaWiki\HTMLForm\HTMLFormField::getHelpText ( )

Determine the help text to display.

Stability: stable: to override

Since: 1.20

Returns: string|null HTML

Definition at line 1102 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getInline(), MediaWiki\HTMLForm\HTMLFormField\getOOUI(), MediaWiki\HTMLForm\HTMLFormField\getRaw(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getHelpTextHtmlDiv()

MediaWiki\HTMLForm\HTMLFormField::getHelpTextHtmlDiv	(		$helptext,
			$cssClasses = [] )

Generate help text HTML in div format.

Since: 1.20

Parameters

string \| null	$helptext
string[]	$cssClasses

Returns: string

Definition at line 1052 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mHelpClass, and MediaWiki\HTMLForm\HTMLFormField\parseCondStateForClient().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlRaw(), and MediaWiki\HTMLForm\HTMLFormField\getInline().

◆ getHelpTextHtmlRaw()

MediaWiki\HTMLForm\HTMLFormField::getHelpTextHtmlRaw ( $helptext )

Generate help text HTML formatted for raw output.

Since: 1.20

Parameters

string | null $helptext

Returns: string

Definition at line 1077 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlDiv().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getRaw().

◆ getHelpTextHtmlTable()

MediaWiki\HTMLForm\HTMLFormField::getHelpTextHtmlTable ( $helptext )

Generate help text HTML in table format.

Since: 1.20

Parameters

string | null $helptext

Returns: string

Definition at line 1023 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mCondStateClass, MediaWiki\HTMLForm\HTMLFormField\$mHelpClass, and MediaWiki\HTMLForm\HTMLFormField\parseCondStateForClient().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getInline()

MediaWiki\HTMLForm\HTMLFormField::getInline ( $value )

Get the complete field as an inline element.

Stability: stable: to override

Since: 1.25

Parameters

string $value The value to set the input to.

Returns: string Complete HTML inline element

Definition at line 1007 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getErrorsAndErrorClass(), MediaWiki\HTMLForm\HTMLFormField\getHelpText(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlDiv(), MediaWiki\HTMLForm\HTMLFormField\getInputHTML(), and MediaWiki\HTMLForm\HTMLFormField\getLabelHtml().

Referenced by MediaWiki\HTMLForm\HTMLForm\formatField().

◆ getInputCodex()

MediaWiki\HTMLForm\HTMLFormField::getInputCodex	(		$value,
			$hasErrors )

Same as getInputHTML, but for Codex.

This is called by CodexHTMLForm.

If not overridden, falls back to getInputHTML.

Parameters

string	$value	The value to set the input to
bool	$hasErrors	Whether there are validation errors. If set to true, this method should apply a CSS class for the error status (e.g. cdx-text-input–status-error) if the component used supports that.

Returns: string HTML

Definition at line 113 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getInputHTML().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex().

◆ getInputHTML()

MediaWiki\HTMLForm\HTMLFormField::getInputHTML ( $value )

abstract

This function must be implemented to return the HTML to generate the input object itself.

It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters

mixed $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getInline(), MediaWiki\HTMLForm\HTMLFormField\getInputCodex(), MediaWiki\HTMLForm\HTMLFormField\getRaw(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getInputOOUI()

MediaWiki\HTMLForm\HTMLFormField::getInputOOUI ( $value )

Same as getInputHTML, but returns an OOUI object.

Defaults to false, which getOOUI will interpret as "use the HTML version"

Stability: stable: to override

Parameters

string $value

Returns: \OOUI\Widget|string|false

Definition at line 98 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getLabel()

MediaWiki\HTMLForm\HTMLFormField::getLabel ( )

Stability: stable: to override

Returns: string HTML

Reimplemented in MediaWiki\HTMLForm\Field\HTMLCheckField.

Definition at line 1183 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), and MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getLabelAlignOOUI()

MediaWiki\HTMLForm\HTMLFormField::getLabelAlignOOUI ( )

protected

Get label alignment when generating field for OOUI.

Stability: stable: to override

Returns: string 'left', 'right', 'top' or 'inline'

Reimplemented in MediaWiki\HTMLForm\Field\HTMLCheckField.

Definition at line 929 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getLabelHtml()

MediaWiki\HTMLForm\HTMLFormField::getLabelHtml ( $cellAttributes = [] )

Stability: stable: to override

Parameters

array $cellAttributes

Returns: string

Reimplemented in UploadSourceField.

Definition at line 1193 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getInline(), MediaWiki\HTMLForm\HTMLFormField\getRaw(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ getMessage()

MediaWiki\HTMLForm\HTMLFormField::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 1433 of file HTMLFormField.php.

References MediaWiki\Message\Message\newFromSpecifier().

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\__construct(), MediaWiki\HTMLForm\Field\HTMLAutoCompleteSelectField\__construct(), MediaWiki\HTMLForm\Field\HTMLFileField\__construct(), MediaWiki\HTMLForm\Field\HTMLSelectAndOtherField\__construct(), MediaWiki\HTMLForm\Field\HTMLTextAreaField\__construct(), MediaWiki\HTMLForm\Field\HTMLTextField\__construct(), MediaWiki\HTMLForm\HTMLFormField\__construct(), and MediaWiki\HTMLForm\Field\HTMLEditTools\formatMsg().

◆ getName()

MediaWiki\HTMLForm\HTMLFormField::getName ( )

Get the field name that will be used for submission.

Since: 1.38

Returns: string

Definition at line 166 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mName.

◆ getNearestField()

MediaWiki\HTMLForm\HTMLFormField::getNearestField	(		$name,
			$backCompat = false )

protected

Get the closest field matching a given name.

It can handle array fields like the user would expect. The general algorithm is to look for $name as a sibling of $this, then a sibling of $this's parent, and so on.

Parameters

string	$name
bool	$backCompat	Whether to try striping the 'wp' prefix.

Returns: HTMLFormField

Definition at line 181 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getNearestFieldValue(), and MediaWiki\HTMLForm\HTMLFormField\parseCondState().

◆ getNearestFieldByName()

MediaWiki\HTMLForm\HTMLFormField::getNearestFieldByName	(	$alldata,
		$name,
		$asDisplay = false )

protected

Fetch a field value from $alldata for the closest field matching a given name.

Deprecated: since 1.38 Use getNearestFieldValue() instead.

Parameters

array	$alldata
string	$name
bool	$asDisplay

Returns: string

Definition at line 242 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getNearestFieldValue().

◆ getNearestFieldValue()

MediaWiki\HTMLForm\HTMLFormField::getNearestFieldValue	(	$alldata,
		$name,
		$asDisplay = false,
		$backCompat = false )

protected

Fetch a field value from $alldata for the closest field matching a given name.

Parameters

array	$alldata
string	$name
bool	$asDisplay	Whether the reverting logic of HTMLCheckField should be ignored.
bool	$backCompat	Whether to try striping the 'wp' prefix.

Returns: mixed

Definition at line 211 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getNearestField().

Referenced by MediaWiki\HTMLForm\HTMLFormField\checkStateRecurse(), and MediaWiki\HTMLForm\HTMLFormField\getNearestFieldByName().

◆ getOOUI()

MediaWiki\HTMLForm\HTMLFormField::getOOUI ( $value )

Get the OOUI version of the div.

Falls back to getDiv by default.

Stability: stable: to override

Since: 1.26

Parameters

string $value The value to set the input to.

Returns: \OOUI\FieldLayout

Reimplemented in MediaWiki\HTMLForm\Field\HTMLInfoField, and MediaWiki\HTMLForm\Field\HTMLTagFilter.

Definition at line 753 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\OOUIHTMLForm\formatField().

◆ getOOUIModules()

MediaWiki\HTMLForm\HTMLFormField::getOOUIModules ( )

protected

Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

Stability: stable: to override

Returns: string[]

Definition at line 963 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ getOptions()

MediaWiki\HTMLForm\HTMLFormField::getOptions ( )

Fetch the array of options from the field's parameters.

In order, this checks 'options-messages', 'options', then 'options-message'.

Returns: array|null

Definition at line 1337 of file HTMLFormField.php.

◆ getOptionsOOUI()

MediaWiki\HTMLForm\HTMLFormField::getOptionsOOUI ( )

Get options and make them into arrays suitable for OOUI.

Stability: stable: to override

Returns: array|null Options for inclusion in a select or whatever.

Reimplemented in MediaWiki\HTMLForm\Field\HTMLMultiSelectField, and MediaWiki\HTMLForm\Field\HTMLOrderedMultiselectField.

Definition at line 1364 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLComboboxField\getInputOOUI(), MediaWiki\HTMLForm\Field\HTMLSelectAndOtherField\getInputOOUI(), MediaWiki\HTMLForm\Field\HTMLSelectField\getInputOOUI(), and MediaWiki\HTMLForm\Field\HTMLSelectOrOtherField\getInputOOUI().

◆ getRaw()

MediaWiki\HTMLForm\HTMLFormField::getRaw ( $value )

Get the complete raw fields for the input, including help text, labels, and whatever.

Stability: stable: to override

Since: 1.20

Parameters

string $value The value to set the input to.

Returns: string Complete HTML table row.

Reimplemented in MediaWiki\HTMLForm\Field\HTMLApiField, MediaWiki\HTMLForm\Field\HTMLEditTools, MediaWiki\HTMLForm\Field\HTMLHiddenField, and MediaWiki\HTMLForm\Field\HTMLInfoField.

Definition at line 977 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getErrorsAndErrorClass(), MediaWiki\HTMLForm\HTMLFormField\getHelpText(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlRaw(), MediaWiki\HTMLForm\HTMLFormField\getInputHTML(), and MediaWiki\HTMLForm\HTMLFormField\getLabelHtml().

Referenced by MediaWiki\HTMLForm\HTMLForm\formatField().

◆ getTableRow()

MediaWiki\HTMLForm\HTMLFormField::getTableRow ( $value )

Get the complete table row for the input, including help text, labels, and whatever.

Stability: stable: to override

Parameters

string $value The value to set the input to.

Returns: string Complete HTML table row.

Reimplemented in MediaWiki\HTMLForm\Field\HTMLApiField, MediaWiki\HTMLForm\Field\HTMLEditTools, MediaWiki\HTMLForm\Field\HTMLHiddenField, MediaWiki\HTMLForm\Field\HTMLInfoField, and MediaWiki\HTMLForm\Field\HTMLTagFilter.

Definition at line 640 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getClassName(), MediaWiki\HTMLForm\HTMLFormField\getErrorsAndErrorClass(), MediaWiki\HTMLForm\HTMLFormField\getHelpText(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlTable(), MediaWiki\HTMLForm\HTMLFormField\getInputHTML(), MediaWiki\HTMLForm\HTMLFormField\getLabelHtml(), MediaWiki\HTMLForm\HTMLFormField\isHidden(), and MediaWiki\HTMLForm\HTMLFormField\parseCondStateForClient().

Referenced by MediaWiki\HTMLForm\HTMLForm\formatField().

◆ getTooltipAndAccessKey()

MediaWiki\HTMLForm\HTMLFormField::getTooltipAndAccessKey ( )

Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

Returns: array Attributes

Definition at line 1234 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLCheckField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLTextAreaField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLTextField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLCheckField\getInputHTML(), MediaWiki\HTMLForm\Field\HTMLFileField\getInputHTML(), MediaWiki\HTMLForm\Field\HTMLTextAreaField\getInputHTML(), and MediaWiki\HTMLForm\Field\HTMLTextField\getInputHTML().

◆ getTooltipAndAccessKeyOOUI()

MediaWiki\HTMLForm\HTMLFormField::getTooltipAndAccessKeyOOUI ( )

Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

Returns: array Attributes

Definition at line 1247 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLCheckField\getInputOOUI(), MediaWiki\HTMLForm\Field\HTMLFileField\getInputOOUI(), MediaWiki\HTMLForm\Field\HTMLTextAreaField\getInputOOUI(), MediaWiki\HTMLForm\Field\HTMLTextField\getInputOOUI(), and MediaWiki\HTMLForm\Field\HTMLToggleSwitchField\getInputOOUI().

◆ getVForm()

MediaWiki\HTMLForm\HTMLFormField::getVForm ( $value )

Get the complete field for the input, including help text, labels, and whatever.

Fall back from 'vform' to 'div' when not overridden.

Stability: stable: to override

Since: 1.25

Parameters

string $value The value to set the input to.

Returns: string Complete HTML field.

Definition at line 994 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getDiv().

Referenced by MediaWiki\HTMLForm\VFormHTMLForm\formatField().

◆ hasVisibleOutput()

MediaWiki\HTMLForm\HTMLFormField::hasVisibleOutput ( )

If this field has a user-visible output or not.

If not, it will not be rendered

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\HTMLForm\Field\HTMLApiField, and MediaWiki\HTMLForm\Field\HTMLHiddenField.

Definition at line 156 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\canDisplayErrors().

◆ isDisabled()

MediaWiki\HTMLForm\HTMLFormField::isDisabled ( $alldata )

Test whether this field is supposed to be disabled, based on the values of the other form fields.

Since: 1.38

Parameters

array $alldata The data collected from the form

Returns: bool

Definition at line 406 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\checkStateRecurse(), and MediaWiki\HTMLForm\HTMLFormField\isHidden().

◆ isHelpInline()

MediaWiki\HTMLForm\HTMLFormField::isHelpInline ( )

Determine if the help text should be displayed inline.

Only applies to OOUI forms.

Since: 1.31

Returns: bool

Definition at line 1127 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI(), and MediaWiki\HTMLForm\HTMLFormField\shouldInfuseOOUI().

◆ isHidden()

MediaWiki\HTMLForm\HTMLFormField::isHidden ( $alldata )

Test whether this field is supposed to be hidden, based on the values of the other form fields.

Since: 1.23

Parameters

array $alldata The data collected from the form

Returns: bool

Definition at line 393 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\checkStateRecurse().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getOOUI(), MediaWiki\HTMLForm\HTMLFormField\getTableRow(), MediaWiki\HTMLForm\HTMLFormField\isDisabled(), MediaWiki\HTMLForm\Field\HTMLRestrictionsField\validate(), and MediaWiki\HTMLForm\HTMLFormField\validate().

◆ isSubmitAttempt()

MediaWiki\HTMLForm\HTMLFormField::isSubmitAttempt ( WebRequest $request )

protected

Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

checkboxes.

Returns true if the request was posted and has a field for a CSRF token (wpEditToken), or has a form identifier (wpFormIdentifier).

Todo: Consider moving this to HTMLForm?

Parameters

WebRequest $request

Returns: bool

Definition at line 518 of file HTMLFormField.php.

References MediaWiki\Request\WebRequest\getCheck(), and MediaWiki\Request\WebRequest\wasPosted().

Referenced by MediaWiki\HTMLForm\Field\HTMLCheckField\loadDataFromRequest(), MediaWiki\HTMLForm\Field\HTMLCheckMatrix\loadDataFromRequest(), and MediaWiki\HTMLForm\Field\HTMLMultiSelectField\loadDataFromRequest().

◆ loadDataFromRequest()

MediaWiki\HTMLForm\HTMLFormField::loadDataFromRequest ( $request )

Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

Stability: stable: to override

Parameters

WebRequest $request

Returns: mixed The value

Definition at line 533 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getDefault().

◆ makeLabelSnippet()

MediaWiki\HTMLForm\HTMLFormField::makeLabelSnippet ( $label )

protected

The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

Convert such a key to either plain text or an HtmlSnippet as appropriate.

FIXME: a dangerous and untidy convention.

Parameters

string $label

Returns: string|\OOUI\HtmlSnippet

Definition at line 1493 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getInputOOUI(), and MediaWiki\HTMLForm\Field\HTMLRadioField\getInputOOUI().

◆ msg()

MediaWiki\HTMLForm\HTMLFormField::msg	(		$key,
			$params )

Get a translated interface message.

This is a wrapper around $this->mParent->msg() if $this->mParent is set and wfMessage() otherwise.

Parameters are the same as wfMessage().

Parameters

string \| string[] \| MessageSpecifier	$key	@phpcs:ignore Generic.Files.LineLength
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$params See Message::params()

Returns: Message

Definition at line 142 of file HTMLFormField.php.

References wfMessage().

◆ needsJSForHtml5FormValidation()

MediaWiki\HTMLForm\HTMLFormField::needsJSForHtml5FormValidation ( )

Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

Returns: bool

Since: 1.29

Definition at line 1461 of file HTMLFormField.php.

◆ needsLabel()

MediaWiki\HTMLForm\HTMLFormField::needsLabel ( )

protected

Should this field have a label, or is there no input element with the appropriate id for the label to point to?

Stability: stable: to override

Returns: bool True to output a label, false to suppress

Reimplemented in MediaWiki\HTMLForm\Field\HTMLButtonField, MediaWiki\HTMLForm\Field\HTMLCheckField, MediaWiki\HTMLForm\Field\HTMLFormFieldCloner, MediaWiki\HTMLForm\Field\HTMLInfoField, MediaWiki\HTMLForm\Field\HTMLMultiSelectField, MediaWiki\HTMLForm\Field\HTMLRadioField, and MediaWiki\HTMLForm\Field\HTMLSizeFilterField.

Definition at line 490 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex().

◆ parseCondState()

MediaWiki\HTMLForm\HTMLFormField::parseCondState ( $params )

protected

Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.

Also check for field existence here.

Parameters

array $params

Returns: mixed[]

Definition at line 347 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\getNearestField(), and MediaWiki\HTMLForm\HTMLFormField\parseCondState().

Referenced by MediaWiki\HTMLForm\HTMLFormField\parseCondState(), and MediaWiki\HTMLForm\HTMLFormField\parseCondStateForClient().

◆ parseCondStateForClient()

MediaWiki\HTMLForm\HTMLFormField::parseCondStateForClient ( )

protected

Parse the cond-state array for client-side.

Returns: array[]

Definition at line 377 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\parseCondState().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getCodex(), MediaWiki\HTMLForm\HTMLFormField\getDiv(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlDiv(), MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlTable(), MediaWiki\HTMLForm\HTMLFormField\getOOUI(), and MediaWiki\HTMLForm\HTMLFormField\getTableRow().

◆ setShowEmptyLabel()

MediaWiki\HTMLForm\HTMLFormField::setShowEmptyLabel ( $show )

Tell the field whether to generate a separate label element if its label is blank.

Since: 1.22

Parameters

bool $show Set to false to not generate a label.

Returns: void

Definition at line 503 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLButtonField\__construct().

◆ shouldInfuseOOUI()

MediaWiki\HTMLForm\HTMLFormField::shouldInfuseOOUI ( )

protected

Whether the field should be automatically infused.

Note that all OOUI HTMLForm fields are infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.

Stability: stable: to override

Returns: bool

Definition at line 951 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\isHelpInline().

Referenced by MediaWiki\HTMLForm\HTMLFormField\getOOUI().

◆ skipLoadData()

MediaWiki\HTMLForm\HTMLFormField::skipLoadData ( $request )

Skip this field when collecting data.

Stability: stable: to override

Parameters

WebRequest $request

Returns: bool

Since: 1.27

Reimplemented in MediaWiki\HTMLForm\Field\HTMLSubmitField.

Definition at line 1450 of file HTMLFormField.php.

◆ validate()

MediaWiki\HTMLForm\HTMLFormField::validate	(		$value,
			$alldata )

Override this function to add specific validation checks on the field input.

Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run

Stability: stable: to override

Parameters

mixed	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: bool|string|Message True on success, or String/Message error to display, or false to fail validation without displaying an error.

Definition at line 440 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\isHidden(), and MediaWiki\HTMLForm\HTMLFormField\msg().

◆ validateCondState()

MediaWiki\HTMLForm\HTMLFormField::validateCondState ( $params )

protected

Validate the cond-state params, the existence check of fields should be done later.

Parameters

array $params

Definition at line 252 of file HTMLFormField.php.

References MediaWiki\HTMLForm\HTMLFormField\validateCondState().

Referenced by MediaWiki\HTMLForm\HTMLFormField\__construct(), and MediaWiki\HTMLForm\HTMLFormField\validateCondState().

Member Data Documentation

◆ $mClass

string MediaWiki\HTMLForm\HTMLFormField::$mClass = ''

protected

Definition at line 44 of file HTMLFormField.php.

◆ $mCondState

array MediaWiki\HTMLForm\HTMLFormField::$mCondState = []

protected

Array to hold params for 'hide-if' or 'disable-if' statements.

Definition at line 63 of file HTMLFormField.php.

◆ $mCondStateClass

array MediaWiki\HTMLForm\HTMLFormField::$mCondStateClass = []

protected

Definition at line 65 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlTable().

◆ $mDefault

mixed MediaWiki\HTMLForm\HTMLFormField::$mDefault

protected

Definition at line 50 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLCheckField\getDefault(), and MediaWiki\HTMLForm\Field\HTMLHiddenField\getHiddenFieldData().

◆ $mDir

string MediaWiki\HTMLForm\HTMLFormField::$mDir

protected

Definition at line 38 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLTextField\getInputCodex(), MediaWiki\HTMLForm\Field\HTMLFileField\getInputHTML(), MediaWiki\HTMLForm\Field\HTMLTextField\getInputHTML(), MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField\getInputOOUI(), and MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputOOUI().

◆ $mHelpClass

string false MediaWiki\HTMLForm\HTMLFormField::$mHelpClass = false

protected

Definition at line 48 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlDiv(), and MediaWiki\HTMLForm\HTMLFormField\getHelpTextHtmlTable().

◆ $mID

string MediaWiki\HTMLForm\HTMLFormField::$mID

protected

Definition at line 42 of file HTMLFormField.php.

◆ $mLabel

string MediaWiki\HTMLForm\HTMLFormField::$mLabel

protected

String label, as HTML.

Set on construction.

Definition at line 40 of file HTMLFormField.php.

◆ $mName

string MediaWiki\HTMLForm\HTMLFormField::$mName

protected

Definition at line 36 of file HTMLFormField.php.

◆ $mOptions

array null false MediaWiki\HTMLForm\HTMLFormField::$mOptions = false

protected

Definition at line 57 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLSelectAndOtherField\__construct(), and MediaWiki\HTMLForm\Field\HTMLSelectOrOtherField\__construct().

◆ $mOptionsLabelsNotFromMessage

bool MediaWiki\HTMLForm\HTMLFormField::$mOptionsLabelsNotFromMessage = false

protected

Definition at line 59 of file HTMLFormField.php.

◆ $mParams

array array [] MediaWiki\HTMLForm\HTMLFormField::$mParams

Definition at line 29 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLExpiryField\getFieldByType().

◆ $mParent

HTMLForm null MediaWiki\HTMLForm\HTMLFormField::$mParent

Definition at line 76 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLRestrictionsField\validate().

◆ $mShowEmptyLabels

bool MediaWiki\HTMLForm\HTMLFormField::$mShowEmptyLabels = true

protected

If true will generate an empty div element with no label.

Since: 1.22

Definition at line 71 of file HTMLFormField.php.

◆ $mVFormClass

string MediaWiki\HTMLForm\HTMLFormField::$mVFormClass = ''

protected

Definition at line 46 of file HTMLFormField.php.

Referenced by MediaWiki\HTMLForm\HTMLFormField\getDiv().

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

includes/htmlform/HTMLFormField.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelSubmit()

◆ canDisplayErrors()

◆ checkStateRecurse()

◆ escapeLabel()

◆ filter()

◆ flattenOptions()

◆ forceToStringRecursive()

◆ formatErrors()

◆ getAttributes()

◆ getClassName()

◆ getCodex()

◆ getDefault()

◆ getDiv()

◆ getErrorsAndErrorClass()

◆ getErrorsRaw()

◆ getFieldLayoutOOUI()

◆ getHelpText()

◆ getHelpTextHtmlDiv()

◆ getHelpTextHtmlRaw()

◆ getHelpTextHtmlTable()

◆ getInline()

◆ getInputCodex()

◆ getInputHTML()

◆ getInputOOUI()

◆ getLabel()

◆ getLabelAlignOOUI()

◆ getLabelHtml()

◆ getMessage()

◆ getName()

◆ getNearestField()

◆ getNearestFieldByName()

◆ getNearestFieldValue()

◆ getOOUI()

◆ getOOUIModules()

◆ getOptions()

◆ getOptionsOOUI()

◆ getRaw()

◆ getTableRow()

◆ getTooltipAndAccessKey()

◆ getTooltipAndAccessKeyOOUI()

◆ getVForm()

◆ hasVisibleOutput()

◆ isDisabled()

◆ isHelpInline()

◆ isHidden()

◆ isSubmitAttempt()

◆ loadDataFromRequest()

◆ makeLabelSnippet()

◆ msg()

◆ needsJSForHtml5FormValidation()

◆ needsLabel()

◆ parseCondState()

◆ parseCondStateForClient()

◆ setShowEmptyLabel()

◆ shouldInfuseOOUI()

◆ skipLoadData()

◆ validate()

◆ validateCondState()

Member Data Documentation

◆ $mClass

◆ $mCondState

◆ $mCondStateClass

◆ $mDefault

◆ $mDir

◆ $mHelpClass

◆ $mID

◆ $mLabel

◆ $mName

◆ $mOptions

◆ $mOptionsLabelsNotFromMessage