MediaWiki  master
HTMLFormField Class Reference

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

Inheritance diagram for HTMLFormField:
Collaboration diagram for HTMLFormField:

Public Member Functions

 __construct ( $params)
 Initialise the object. More...
 
 cancelSubmit ( $value, $alldata)
 Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm. More...
 
 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. More...
 
 filter ( $value, $alldata)
 
 getAttributes (array $list)
 Returns the given attributes from the parameters. More...
 
 getDefault ()
 
 getDiv ( $value)
 Get the complete div for the input, including help text, labels, and whatever. More...
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getErrorsRaw ( $value)
 Determine form errors to display, returning them in an array. More...
 
 getHelpText ()
 Determine the help text to display. More...
 
 getHelpTextHtmlDiv ( $helptext)
 Generate help text HTML in div format. More...
 
 getHelpTextHtmlRaw ( $helptext)
 Generate help text HTML formatted for raw output. More...
 
 getHelpTextHtmlTable ( $helptext)
 Generate help text HTML in table format. More...
 
 getInline ( $value)
 Get the complete field as an inline element. More...
 
 getInputHTML ( $value)
 This function must be implemented to return the HTML to generate the input object itself. More...
 
 getInputOOUI ( $value)
 Same as getInputHTML, but returns an OOUI object. More...
 
 getLabel ()
 
 getLabelHtml ( $cellAttributes=[])
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getOptionsOOUI ()
 Get options and make them into arrays suitable for OOUI. More...
 
 getRaw ( $value)
 Get the complete raw fields for the input, including help text, labels, and whatever. More...
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey, for Html::element() etc. More...
 
 getTooltipAndAccessKeyOOUI ()
 Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config. More...
 
 getVForm ( $value)
 Get the complete field for the input, including help text, labels, and whatever. More...
 
 hasVisibleOutput ()
 If this field has a user-visible output or not. More...
 
 isHelpInline ()
 Determine if the help text should be displayed inline. More...
 
 isHidden ( $alldata)
 Test whether this field is supposed to be hidden, based on the values of the other form fields. More...
 
 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. More...
 
 msg ()
 Get a translated interface message. More...
 
 needsJSForHtml5FormValidation ()
 Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 skipLoadData ( $request)
 Skip this field when collecting data. More...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 

Static Public Member Functions

static flattenOptions ( $options)
 flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>". More...
 
static forceToStringRecursive ( $array)
 Recursively forces values in an array to strings, because issues arise with integer 0 as a value. More...
 

Public Attributes

 $mParams
 
HTMLForm null $mParent
 

Protected Member Functions

 getFieldLayoutOOUI ( $inputField, $config)
 Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. More...
 
 getLabelAlignOOUI ()
 Get label alignment when generating field for OOUI. 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...
 
 getNearestFieldByName ( $alldata, $name)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 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. More...
 
 isHiddenRecurse (array $alldata, array $params)
 Helper function for isHidden to handle recursive data structures. More...
 
 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. More...
 
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 

Static Protected Member Functions

static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 

Protected Attributes

 $mClass = ''
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mHideIf = null
 
 $mID
 
 $mLabel
 
 $mName
 
array bool null $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $mVFormClass = ''
 

Private Member Functions

 lookupOptionsKeys ( $options)
 Given an array of msg-key => value mappings, returns an array with keys being the message texts. More...
 

Detailed Description

The parent class to generate form fields.

Any field type should be a subclass of this.

Definition at line 7 of file HTMLFormField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLFormField::__construct (   $params)

Initialise the object.

Parameters
array$paramsAssociative Array. See HTMLForm doc for syntax.
Since
1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
Exceptions
MWException

Definition at line 388 of file HTMLFormField.php.

References $params, and getMessage().

Member Function Documentation

◆ cancelSubmit()

HTMLFormField::cancelSubmit (   $value,
  $alldata 
)

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

Since
1.23
Parameters
string | array$valueThe value the field was submitted with
array$alldataThe data collected from the form
Returns
bool True to cancel the submission

Definition at line 286 of file HTMLFormField.php.

◆ canDisplayErrors()

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.

Returns
bool

Definition at line 66 of file HTMLFormField.php.

References hasVisibleOutput().

◆ filter()

HTMLFormField::filter (   $value,
  $alldata 
)

Definition at line 320 of file HTMLFormField.php.

References $mFilterCallback, and $value.

◆ flattenOptions()

static HTMLFormField::flattenOptions (   $options)
static

◆ forceToStringRecursive()

static HTMLFormField::forceToStringRecursive (   $array)
static

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

Parameters
array$array
Returns
array|string

Definition at line 1038 of file HTMLFormField.php.

Referenced by HTMLMultiSelectField\filterDataForSubmit(), and HTMLMultiSelectField\getInputHTML().

◆ formatErrors()

static HTMLFormField::formatErrors (   $errors)
staticprotected

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

Parameters
string | Message | array$errorsArray 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.

Definition at line 1118 of file HTMLFormField.php.

References $lines, as, and Html\rawElement().

◆ getAttributes()

◆ getDefault()

◆ getDiv()

HTMLFormField::getDiv (   $value)

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

Since
1.20
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Definition at line 532 of file HTMLFormField.php.

References $html, $mClass, $mVFormClass, $value, class, FormatJson\encode(), getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlDiv(), getInputHTML(), getLabelHtml(), list, and Html\rawElement().

Referenced by getOOUI(), and getVForm().

◆ getErrorsAndErrorClass()

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$valueThe value of the input
Returns
array array( $errors, $errorClass )
-taint none

Definition at line 872 of file HTMLFormField.php.

References $value, and validate().

Referenced by getDiv(), getInline(), getRaw(), HTMLCheckMatrix\getTableRow(), and getTableRow().

◆ getErrorsRaw()

HTMLFormField::getErrorsRaw (   $value)

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

Since
1.26
Parameters
string$valueThe value of the input
Returns
string[] Array of error HTML strings

Definition at line 893 of file HTMLFormField.php.

References $value, as, and validate().

Referenced by getOOUI().

◆ getFieldLayoutOOUI()

HTMLFormField::getFieldLayoutOOUI (   $inputField,
  $config 
)
protected

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

Parameters
string$inputField
array$config
Returns
OOUI\FieldLayout|OOUI\ActionFieldLayout

Definition at line 660 of file HTMLFormField.php.

Referenced by getOOUI().

◆ getHelpText()

HTMLFormField::getHelpText ( )

Determine the help text to display.

Since
1.20
Returns
string|null HTML

Definition at line 821 of file HTMLFormField.php.

References as, getMessage(), msg(), and null.

Referenced by getDiv(), getInline(), getOOUI(), getRaw(), HTMLCheckMatrix\getTableRow(), getTableRow(), and shouldInfuseOOUI().

◆ getHelpTextHtmlDiv()

HTMLFormField::getHelpTextHtmlDiv (   $helptext)

Generate help text HTML in div format.

Since
1.20
Parameters
string | null$helptext
Returns
string

Definition at line 785 of file HTMLFormField.php.

References FormatJson\encode(), and Html\rawElement().

Referenced by getDiv(), getHelpTextHtmlRaw(), and getInline().

◆ getHelpTextHtmlRaw()

HTMLFormField::getHelpTextHtmlRaw (   $helptext)

Generate help text HTML formatted for raw output.

Since
1.20
Parameters
string | null$helptext
Returns
string

Definition at line 812 of file HTMLFormField.php.

References getHelpTextHtmlDiv().

Referenced by getRaw().

◆ getHelpTextHtmlTable()

HTMLFormField::getHelpTextHtmlTable (   $helptext)

Generate help text HTML in table format.

Since
1.20
Parameters
string | null$helptext
Returns
string

Definition at line 756 of file HTMLFormField.php.

References $mHelpClass, FormatJson\encode(), and Html\rawElement().

Referenced by HTMLCheckMatrix\getTableRow(), and getTableRow().

◆ getInline()

HTMLFormField::getInline (   $value)

Get the complete field as an inline element.

Since
1.25
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML inline element

Definition at line 734 of file HTMLFormField.php.

References $html, $value, getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlDiv(), getInputHTML(), getLabelHtml(), and list.

◆ getInputHTML()

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
string$valueThe value to set the input to; eg a default text for a text input.
Returns
string Valid HTML.

Referenced by getDiv(), getInline(), getRaw(), and getTableRow().

◆ getInputOOUI()

HTMLFormField::getInputOOUI (   $value)

Same as getInputHTML, but returns an OOUI object.

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

Parameters
string$value
Returns
OOUI\Widget|false

Definition at line 57 of file HTMLFormField.php.

Referenced by getOOUI().

◆ getLabel()

HTMLFormField::getLabel ( )
Returns
string HTML

Definition at line 915 of file HTMLFormField.php.

Referenced by getLabelHtml(), and getOOUI().

◆ getLabelAlignOOUI()

HTMLFormField::getLabelAlignOOUI ( )
protected

Get label alignment when generating field for OOUI.

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

Definition at line 650 of file HTMLFormField.php.

Referenced by getOOUI().

◆ getLabelHtml()

HTMLFormField::getLabelHtml (   $cellAttributes = [])

◆ getMessage()

HTMLFormField::getMessage (   $value)
protected

◆ getNearestFieldByName()

HTMLFormField::getNearestFieldByName (   $alldata,
  $name 
)
protected

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

This is complex because it needs to 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. Keeping in mind that $name itself might be referencing an array.

Parameters
array$alldata
string$name
Returns
string

Definition at line 112 of file HTMLFormField.php.

References $data, $keys, $mName, $name, as, and string.

Referenced by isHiddenRecurse().

◆ getOOUI()

HTMLFormField::getOOUI (   $value)

Get the OOUI version of the div.

Falls back to getDiv by default.

Since
1.26
Parameters
string$valueThe value to set the input to.
Returns
OOUI\FieldLayout|OOUI\ActionFieldLayout

Definition at line 580 of file HTMLFormField.php.

References $help, $mClass, $mHideIf, $value, as, class, getDiv(), getErrorsRaw(), getFieldLayoutOOUI(), getHelpText(), getInputOOUI(), getLabel(), getLabelAlignOOUI(), getOOUIModules(), isHelpInline(), null, and shouldInfuseOOUI().

◆ getOOUIModules()

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.

Returns
string[]

Definition at line 686 of file HTMLFormField.php.

Referenced by getOOUI().

◆ getOptions()

◆ getOptionsOOUI()

HTMLFormField::getOptionsOOUI ( )

Get options and make them into arrays suitable for OOUI.

Returns
array Options for inclusion in a select or whatever.

Definition at line 1074 of file HTMLFormField.php.

References getOptions(), Xml\listDropDownOptionsOoui(), and null.

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

◆ getRaw()

HTMLFormField::getRaw (   $value)

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

Since
1.20
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Definition at line 699 of file HTMLFormField.php.

References $html, $value, getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlRaw(), getInputHTML(), getLabelHtml(), and list.

◆ getTableRow()

HTMLFormField::getTableRow (   $value)

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

Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Definition at line 474 of file HTMLFormField.php.

References $html, $value, class, FormatJson\encode(), getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlTable(), getInputHTML(), getLabelHtml(), list, and Html\rawElement().

◆ getTooltipAndAccessKey()

HTMLFormField::getTooltipAndAccessKey ( )

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

Returns
array Attributes

Definition at line 966 of file HTMLFormField.php.

References Linker\tooltipAndAccesskeyAttribs().

Referenced by HTMLCheckField\getInputHTML(), HTMLTextAreaField\getInputHTML(), and HTMLTextField\getInputHTML().

◆ getTooltipAndAccessKeyOOUI()

HTMLFormField::getTooltipAndAccessKeyOOUI ( )

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

Returns
array Attributes

Definition at line 979 of file HTMLFormField.php.

References Linker\accesskey(), and Linker\titleAttrib().

Referenced by HTMLCheckField\getInputOOUI(), HTMLTextAreaField\getInputOOUI(), and HTMLTextField\getInputOOUI().

◆ getVForm()

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.

Since
1.25
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML field.

Definition at line 722 of file HTMLFormField.php.

References $value, and getDiv().

◆ hasVisibleOutput()

HTMLFormField::hasVisibleOutput ( )

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

If not, it will not be rendered

Returns
bool

Definition at line 95 of file HTMLFormField.php.

Referenced by canDisplayErrors().

◆ isHelpInline()

HTMLFormField::isHelpInline ( )

Determine if the help text should be displayed inline.

Only applies to OOUI forms.

Since
1.31
Returns
bool

Definition at line 856 of file HTMLFormField.php.

Referenced by getOOUI(), and shouldInfuseOOUI().

◆ isHidden()

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$alldataThe data collected from the form
Returns
bool

Definition at line 268 of file HTMLFormField.php.

References isHiddenRecurse().

Referenced by HTMLRestrictionsField\validate(), and validate().

◆ isHiddenRecurse()

HTMLFormField::isHiddenRecurse ( array  $alldata,
array  $params 
)
protected

Helper function for isHidden to handle recursive data structures.

Parameters
array$alldata
array$params
Returns
bool
Exceptions
MWException

Definition at line 161 of file HTMLFormField.php.

References $params, $value, as, getNearestFieldByName(), and list.

Referenced by isHidden().

◆ isSubmitAttempt()

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 has a field for a CSRF token (wpEditToken) or a form identifier (wpFormIdentifier).

Parameters
WebRequest$request
Returns
bool

Definition at line 361 of file HTMLFormField.php.

References WebRequest\getCheck().

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

◆ loadDataFromRequest()

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.

Parameters
WebRequest$request
Returns
string The value

Definition at line 372 of file HTMLFormField.php.

References $request, and getDefault().

◆ lookupOptionsKeys()

HTMLFormField::lookupOptionsKeys (   $options)
private

Given an array of msg-key => value mappings, returns an array with keys being the message texts.

It also forces values to strings.

Parameters
array$options
Returns
array

Definition at line 1020 of file HTMLFormField.php.

References $options, $ret, $value, as, and msg().

Referenced by getOptions().

◆ msg()

◆ needsJSForHtml5FormValidation()

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 1179 of file HTMLFormField.php.

◆ needsLabel()

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?

Returns
bool True to output a label, false to suppress

Definition at line 334 of file HTMLFormField.php.

Referenced by getLabelHtml().

◆ setShowEmptyLabel()

HTMLFormField::setShowEmptyLabel (   $show)

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

Since
1.22
Parameters
bool$showSet to false to not generate a label.
Returns
void

Definition at line 347 of file HTMLFormField.php.

Referenced by HTMLButtonField\__construct().

◆ shouldInfuseOOUI()

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.

Returns
bool

Definition at line 675 of file HTMLFormField.php.

References getHelpText(), isHelpInline(), and null.

Referenced by getOOUI().

◆ skipLoadData()

HTMLFormField::skipLoadData (   $request)

Skip this field when collecting data.

Parameters
WebRequest$request
Returns
bool
Since
1.27

Definition at line 1168 of file HTMLFormField.php.

◆ validate()

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

Parameters
string | array$valueThe value the field was submitted with
array$alldataThe 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 301 of file HTMLFormField.php.

References $mParent, $value, isHidden(), and msg().

Referenced by getErrorsAndErrorClass(), getErrorsRaw(), EditWatchlistCheckboxSeriesField\validate(), and HTMLCheckMatrixTest\validate().

Member Data Documentation

◆ $mClass

◆ $mDefault

HTMLFormField::$mDefault
protected

Definition at line 19 of file HTMLFormField.php.

Referenced by HTMLHiddenField\getHiddenFieldData().

◆ $mDir

◆ $mFilterCallback

HTMLFormField::$mFilterCallback
protected

Definition at line 11 of file HTMLFormField.php.

Referenced by filter().

◆ $mHelpClass

HTMLFormField::$mHelpClass = false
protected

Definition at line 18 of file HTMLFormField.php.

Referenced by getHelpTextHtmlTable().

◆ $mHideIf

HTMLFormField::$mHideIf = null
protected

Definition at line 25 of file HTMLFormField.php.

Referenced by HTMLFormFieldCloner\createFieldsForKey(), and getOOUI().

◆ $mID

◆ $mLabel

HTMLFormField::$mLabel
protected

Definition at line 14 of file HTMLFormField.php.

Referenced by HTMLCheckField\getLabel().

◆ $mName

◆ $mOptions

array bool null HTMLFormField::$mOptions = false
protected

◆ $mOptionsLabelsNotFromMessage

HTMLFormField::$mOptionsLabelsNotFromMessage = false
protected

Definition at line 24 of file HTMLFormField.php.

◆ $mParams

HTMLFormField::$mParams

Definition at line 8 of file HTMLFormField.php.

Referenced by HTMLExpiryField\getFieldByType().

◆ $mParent

HTMLForm null HTMLFormField::$mParent

Definition at line 36 of file HTMLFormField.php.

Referenced by validate().

◆ $mShowEmptyLabels

bool HTMLFormField::$mShowEmptyLabels = true
protected

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

Since
1.22

Definition at line 31 of file HTMLFormField.php.

◆ $mValidationCallback

HTMLFormField::$mValidationCallback
protected

Definition at line 10 of file HTMLFormField.php.

◆ $mVFormClass

HTMLFormField::$mVFormClass = ''
protected

Definition at line 17 of file HTMLFormField.php.

Referenced by getDiv().


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