A combo box field. More...
Public Member Functions | |
| getAttributes (array $list) | |
| Returns the given attributes from the parameters. | |
| 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. | |
 Public Member Functions inherited from HTMLTextField | |
| __construct ( $params) | |
| getSize () | |
| getSpellCheck () | |
| isPersistent () | |
| 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. | |
| 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) | |
| 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=[]) | |
| getNotices () | |
| Determine notices to display for the field. | |
| 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. | |
| 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 () | |
| 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. | |
Protected Member Functions | |
| shouldInfuseOOUI () | |
| Whether the field should be automatically infused. | |
| Protected Member Functions inherited from HTMLTextField | |
| getDataAttribs () | |
| Returns an array of data-* attributes to add to the field. | |
| getInputWidget ( $params) | |
| getType (&$attribs) | |
| 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 | |
| $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 HTMLTextField | |
| bool | $autocomplete |
| HTML autocomplete attribute. | |
| $mPlaceholder = '' | |
| Protected Attributes inherited from HTMLFormField | |
| $mClass = '' | |
| $mDefault | |
| $mDir | |
| $mFilterCallback | |
| $mHelpClass = false | |
| $mHideIf = null | |
| $mID | |
| $mLabel | |
| $mName | |
| $mOptions = false | |
| $mOptionsLabelsNotFromMessage = false | |
| bool | $mShowEmptyLabels = true |
| If true will generate an empty div element with no label. | |
| $mValidationCallback | |
| $mVFormClass = '' | |
Detailed Description
A combo box field.
You can think of it as a dropdown select with the ability to add custom options, or as a text field with input suggestions (autocompletion).
When JavaScript is not supported or enabled, it uses HTML5 <datalist> element.
Besides the parameters recognized by HTMLTextField, the following are recognized: options-messages - As for HTMLSelectField options - As for HTMLSelectField options-message - As for HTMLSelectField
Definition at line 17 of file HTMLComboboxField.php.
Member Function Documentation
◆ getAttributes()
| HTMLComboboxField::getAttributes | ( | array | $list | ) |
Returns the given attributes from the parameters.
- Parameters
-
array $list List of attributes to get
- Returns
- array Attributes
Reimplemented from HTMLFormField.
Definition at line 19 of file HTMLComboboxField.php.
References $attribs.
Referenced by getInputOOUI().
◆ getInputHTML()
| HTMLComboboxField::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
-
string $value The value to set the input to; eg a default text for a text input.
- Returns
- string Valid HTML.
Reimplemented from HTMLTextField.
Definition at line 28 of file HTMLComboboxField.php.
References $value, and HTMLFormField\getOptions().
◆ getInputOOUI()
| HTMLComboboxField::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
Reimplemented from HTMLTextField.
Definition at line 36 of file HTMLComboboxField.php.
References $attribs, HTMLFormField\$mClass, $value, getAttributes(), and HTMLFormField\getOptionsOOUI().
◆ 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
Reimplemented from HTMLFormField.
Definition at line 60 of file HTMLComboboxField.php.
The documentation for this class was generated from the following file:
- includes/htmlform/fields/HTMLComboboxField.php
