HTMLSelectField Class Reference

A select dropdown field. More...

Inheritance diagram for HTMLSelectField:

Collaboration diagram for HTMLSelectField:

Public Member Functions
	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)
	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|false
	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 HTMLFormField
	__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.
	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)
	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.
	getLabel ()
	getLabelHtml ( $cellAttributes=[])
	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.
	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.

Protected Member Functions
	shouldInfuseOOUI ()
	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
Protected Member Functions inherited from HTMLFormField
	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.
	getNearestFieldByName ( $alldata, $name)
	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.
	isHiddenRecurse (array $alldata, array $params)
	Helper function for isHidden to handle recursive data structures.
	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.
	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?

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>".
static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.
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.
Protected Attributes inherited from HTMLFormField
	$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.
	$mValidationCallback
	$mVFormClass = ''

Detailed Description

A select dropdown field.

Basically a wrapper for Xmlselect class

Stability: stable

to extend

Definition at line 8 of file HTMLSelectField.php.

Member Function Documentation

getInputHTML()

HTMLSelectField::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 HTMLFormField.

Reimplemented in HTMLSelectAndOtherField.

Definition at line 34 of file HTMLSelectField.php.

References HTMLFormField\getAttributes(), and HTMLFormField\getOptions().

getInputOOUI()

HTMLSelectField::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|false

Stability: stable

to override

Reimplemented from HTMLFormField.

Reimplemented in HTMLSelectAndOtherField.

Definition at line 60 of file HTMLSelectField.php.

References HTMLFormField\$mClass, HTMLFormField\getAttributes(), and HTMLFormField\getOptionsOOUI().

shouldInfuseOOUI()

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

Stability: stable

to override

Reimplemented from HTMLFormField.

Definition at line 88 of file HTMLSelectField.php.

validate()

HTMLSelectField::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 HTMLFormField.

Reimplemented in HTMLSelectAndOtherField, and HTMLSelectLimitField.

Definition at line 14 of file HTMLSelectField.php.

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

---

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

• includes/htmlform/fields/HTMLSelectField.php