MediaWiki  master
HTMLMultiSelectField Class Reference

Multi-select field. More...

Inheritance diagram for HTMLMultiSelectField:
Collaboration diagram for HTMLMultiSelectField:

Public Member Functions

 __construct ( $params)
 
 filterDataForSubmit ( $data)
 Support for separating multi-option preferences into multiple preferences Due to lack of array support.
Parameters
array$data
More...
 
 formatOptions ( $options, $value)
 
 getDefault ()
 
Stability: stable
to override
Returns
mixed
More...
 
 getInputHTML ( $value)
 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$valueThe value to set the input to; eg a default text for a text input.
Returns
string Valid HTML.
More...
 
 getInputOOUI ( $value)
 Get the OOUI version of this field. More...
 
 getOptionsOOUI ()
 Get options and make them into arrays suitable for OOUI. More...
 
 loadDataFromRequest ( $request)
 
 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$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.
More...
 
- Public Member Functions inherited from HTMLFormField
 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...
 
 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...
 
 getLabel ()
 
 getLabelHtml ( $cellAttributes=[])
 
 getName ()
 Get the field name that will be used for submission. More...
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getOptions ()
 Fetch the array of options from the field's parameters. 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...
 
 isDisabled ( $alldata)
 Test whether this field is supposed to be disabled, based on the values of the other form fields. 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...
 
 msg ( $key,... $params)
 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...
 

Protected Member Functions

 getOneCheckbox ( $checked, $attribs, $label)
 
 needsLabel ()
 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
More...
 
- Protected Member Functions inherited from HTMLFormField
 checkStateRecurse (array $alldata, array $params)
 Helper function for isHidden and isDisabled to handle recursive data structures. More...
 
 getClassName ()
 Gets the non namespaced class name. More...
 
 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...
 
 getNearestField ( $name, $backCompat=false)
 Get the closest field matching a given name. More...
 
 getNearestFieldByName ( $alldata, $name, $asDisplay=false)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
 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...
 
 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...
 
 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. More...
 
 parseCondStateForClient ()
 Parse the cond-state array for client-side. More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
 validateCondState ( $params)
 Validate the cond-state params, the existence check of fields should be done later. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HTMLFormField
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 inherited from HTMLFormField
array array[] $mParams
 
HTMLForm null $mParent
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
array $mCondState = []
 Array to hold params for 'hide-if' or 'disable-if' statements. More...
 
 $mCondStateClass = []
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mID
 
 $mLabel
 
 $mName
 
array null false $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $mVFormClass = ''
 

Detailed Description

Multi-select field.

Stability: stable
to extend

Definition at line 10 of file HTMLMultiSelectField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLMultiSelectField::__construct (   $params)
Stability: stable
to call
Parameters
array$paramsIn adition to the usual HTMLFormField parameters, this can take the following fields:
  • dropdown: If given, the options will be displayed inside a dropdown with a text field that can be used to filter them. This is desirable mostly for very long lists of options. This only works for users with JavaScript support and falls back to the list of checkboxes.
  • flatlist: If given, the options will be displayed on a single line (wrapping to following lines if necessary), rather than each one on a line of its own. This is desirable mostly for very short lists of concisely labelled options.

Reimplemented from HTMLFormField.

Definition at line 26 of file HTMLMultiSelectField.php.

References HTMLFormField\msg().

Member Function Documentation

◆ filterDataForSubmit()

HTMLMultiSelectField::filterDataForSubmit (   $data)

Support for separating multi-option preferences into multiple preferences Due to lack of array support.

Parameters
array$data

Stability: stable
to override

Implements HTMLNestedFilterable.

Definition at line 295 of file HTMLMultiSelectField.php.

References $res, HTMLFormField\flattenOptions(), HTMLFormField\forceToStringRecursive(), getDefault(), and HTMLFormField\getOptions().

◆ formatOptions()

HTMLMultiSelectField::formatOptions (   $options,
  $value 
)
Stability: stable
to override
Parameters
array$options
mixed$value
Returns
string
Exceptions
MWException

Definition at line 102 of file HTMLMultiSelectField.php.

References HTMLFormField\getAttributes(), getOneCheckbox(), and Html\rawElement().

Referenced by getInputHTML().

◆ getDefault()

HTMLMultiSelectField::getDefault ( )

Stability: stable
to override
Returns
mixed

Stability: stable
to override

Reimplemented from HTMLFormField.

Definition at line 287 of file HTMLMultiSelectField.php.

Referenced by filterDataForSubmit(), and loadDataFromRequest().

◆ getInputHTML()

HTMLMultiSelectField::getInputHTML (   $value)

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

Stability: stable
to override

Reimplemented from HTMLFormField.

Definition at line 82 of file HTMLMultiSelectField.php.

References HTMLFormField\forceToStringRecursive(), formatOptions(), and HTMLFormField\getOptions().

◆ getInputOOUI()

HTMLMultiSelectField::getInputOOUI (   $value)

Get the OOUI version of this field.

Returns OOUI\CheckboxMultiselectInputWidget for fields that only have one section, string otherwise.

Stability: stable
to override
Since
1.28
Parameters
string[]$value
Returns
string|OOUI\CheckboxMultiselectInputWidget

Reimplemented from HTMLFormField.

Definition at line 179 of file HTMLMultiSelectField.php.

References HTMLFormField\$mClass, HTMLFormField\getAttributes(), HTMLFormField\getOptions(), and Xml\listDropDownOptionsOoui().

◆ getOneCheckbox()

HTMLMultiSelectField::getOneCheckbox (   $checked,
  $attribs,
  $label 
)
protected

Definition at line 134 of file HTMLMultiSelectField.php.

References Xml\check(), Html\closeElement(), and Html\openElement().

Referenced by formatOptions().

◆ getOptionsOOUI()

HTMLMultiSelectField::getOptionsOOUI ( )

Get options and make them into arrays suitable for OOUI.

Stability: stable
to override
Exceptions
MWException

Reimplemented from HTMLFormField.

Definition at line 161 of file HTMLMultiSelectField.php.

◆ loadDataFromRequest()

HTMLMultiSelectField::loadDataFromRequest (   $request)
Stability: stable
to override
Parameters
WebRequest$request
Returns
string|array

Reimplemented from HTMLFormField.

Definition at line 267 of file HTMLMultiSelectField.php.

References getDefault(), and HTMLFormField\isSubmitAttempt().

◆ needsLabel()

HTMLMultiSelectField::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

Stability: stable
to override

Reimplemented from HTMLFormField.

Definition at line 312 of file HTMLMultiSelectField.php.

◆ validate()

HTMLMultiSelectField::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$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.

Stability: stable
to override

Reimplemented from HTMLFormField.

Reimplemented in EditWatchlistCheckboxSeriesField.

Definition at line 52 of file HTMLMultiSelectField.php.

References HTMLFormField\flattenOptions(), HTMLFormField\getOptions(), and HTMLFormField\msg().


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