Multi-select field. More...

Inherits MediaWiki\HTMLForm\HTMLFormField, and MediaWiki\HTMLForm\HTMLNestedFilterable.

Inherited by EditWatchlistCheckboxSeriesField.

Collaboration diagram for MediaWiki\HTMLForm\Field\HTMLMultiSelectField:

[legend]

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

formatOptions ( $options, $value)

getDefault ()

Stability: stable: to override

Returns: mixed

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 $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

getInputOOUI ( $value)

Get the OOUI version of this field.

getOptionsOOUI ()

Get options and make them into arrays suitable for OOUI.

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

Public Member Functions inherited from 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.

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.

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.

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.

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.

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.

Protected Member Functions
	getOneCheckbox ( $checked, $attribs, $label)

	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.

	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

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
	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.

	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.

	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.

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

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
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 inherited from MediaWiki\HTMLForm\HTMLFormField
array array[]	$mParams

HTMLForm null	$mParent

Static Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Protected Attributes inherited from MediaWiki\HTMLForm\HTMLFormField
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

Multi-select field.

Stability: stable: to extend

Definition at line 19 of file HTMLMultiSelectField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::__construct ( $params )

Stability: stable: to call

Parameters

array

$params

In 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.
max: Maximum number of elements that can be selected. On the client-side, this is only enforced when using a dropdown.

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 39 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\HTMLFormField\msg().

Member Function Documentation

◆ filterDataForSubmit()

MediaWiki\HTMLForm\Field\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 MediaWiki\HTMLForm\HTMLNestedFilterable.

Definition at line 319 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\HTMLFormField\flattenOptions(), MediaWiki\HTMLForm\HTMLFormField\forceToStringRecursive(), MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getDefault(), and MediaWiki\HTMLForm\HTMLFormField\getOptions().

◆ formatOptions()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::formatOptions	(		$options,
			$value )

Stability: stable: to override

Parameters

array	$options
mixed	$value

Returns: string

Definition at line 121 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\Field\HTMLMultiSelectField\formatOptions(), MediaWiki\HTMLForm\HTMLFormField\getAttributes(), and MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getOneCheckbox().

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

◆ getDefault()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::getDefault ( )

Stability: stable: to override

Returns: mixed

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 311 of file HTMLMultiSelectField.php.

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

◆ getInputHTML()

MediaWiki\HTMLForm\Field\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 $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 106 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\HTMLFormField\forceToStringRecursive(), MediaWiki\HTMLForm\Field\HTMLMultiSelectField\formatOptions(), and MediaWiki\HTMLForm\HTMLFormField\getOptions().

◆ getInputOOUI()

MediaWiki\HTMLForm\Field\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: \OOUI\Widget|string

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 205 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mClass, MediaWiki\HTMLForm\HTMLFormField\getAttributes(), MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getOptionsOOUI(), and MediaWiki\HTMLForm\HTMLFormField\makeLabelSnippet().

◆ getOneCheckbox()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::getOneCheckbox	(	$checked,
		$attribs,
		$label )

protected

Definition at line 153 of file HTMLMultiSelectField.php.

References MediaWiki\Html\Html\check(), and MediaWiki\HTMLForm\HTMLFormField\escapeLabel().

Referenced by MediaWiki\HTMLForm\Field\HTMLMultiSelectField\formatOptions().

◆ getOOUIModules()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::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[]

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 277 of file HTMLMultiSelectField.php.

◆ getOptionsOOUI()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::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 from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 169 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\HTMLFormField\getOptions().

Referenced by MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getInputOOUI().

◆ loadDataFromRequest()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::loadDataFromRequest ( $request )

Stability: stable: to override

Parameters

WebRequest $request

Returns: string|array

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 291 of file HTMLMultiSelectField.php.

References MediaWiki\HTMLForm\Field\HTMLMultiSelectField\getDefault(), and MediaWiki\HTMLForm\HTMLFormField\isSubmitAttempt().

◆ needsLabel()

MediaWiki\HTMLForm\Field\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 MediaWiki\HTMLForm\HTMLFormField.

Definition at line 336 of file HTMLMultiSelectField.php.

◆ shouldInfuseOOUI()

MediaWiki\HTMLForm\Field\HTMLMultiSelectField::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

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 281 of file HTMLMultiSelectField.php.

◆ validate()

MediaWiki\HTMLForm\Field\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	$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.

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Reimplemented in EditWatchlistCheckboxSeriesField.

Definition at line 65 of file HTMLMultiSelectField.php.

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

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

includes/htmlform/fields/HTMLMultiSelectField.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ filterDataForSubmit()

◆ formatOptions()

◆ getDefault()

◆ getInputHTML()

◆ getInputOOUI()

◆ getOneCheckbox()

◆ getOOUIModules()

◆ getOptionsOOUI()

◆ loadDataFromRequest()

◆ needsLabel()

◆ shouldInfuseOOUI()

◆ validate()