MediaWiki  master
HTMLAutoCompleteSelectField Class Reference

Text field for selecting a value from a large list of possible values, with auto-completion and optionally with a select dropdown for selecting common options. More...

Inheritance diagram for HTMLAutoCompleteSelectField:
Collaboration diagram for HTMLAutoCompleteSelectField:

Public Member Functions

 __construct ( $params)
 Stable to call Stable to call.
Parameters
array$params
  • type: HTML textfield type
  • size: field size in characters (defaults to 45)
  • placeholder/placeholder-message: set HTML placeholder attribute
  • spellcheck: set HTML spellcheck attribute
  • persistent: upon unsuccessful requests, retain the value (defaults to true, except for password fields)
. More...
 
 getAttributes (array $list)
 Returns the given attributes from the parameters Stable to override. 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.
Stable to override Stable to override More...
 
 getInputOOUI ( $value)
 Get the OOUI version of this input. 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...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 
- Public Member Functions inherited from HTMLTextField
 getSize ()
 Stable to override. More...
 
 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. 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)
 Stable to override. More...
 
 getDefault ()
 Stable to override. 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 Stable to override. 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 ()
 Stable to override. More...
 
 getLabelHtml ( $cellAttributes=[])
 Stable to override. More...
 
 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...
 
 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 Attributes

 $autocompleteData = []
 
- Protected Attributes inherited from HTMLTextField
bool $autocomplete
 HTML autocomplete attribute. More...
 
 $mPlaceholder = ''
 
- 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. More...
 
 $mValidationCallback
 
 $mVFormClass = ''
 

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
 
- Protected Member Functions inherited from HTMLTextField
 getDataAttribs ()
 Returns an array of data-* attributes to add to the field. More...
 
 getInputWidget ( $params)
 Stable to override. More...
 
 getType (&$attribs)
 
- Protected Member Functions inherited from HTMLFormField
 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? Stable to override. More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 

Detailed Description

Text field for selecting a value from a large list of possible values, with auto-completion and optionally with a select dropdown for selecting common options.

HTMLComboboxField implements most of the same functionality and should be used instead, if possible.

If one of 'options-messages', 'options', or 'options-message' is provided and non-empty, the select dropdown will be shown. An 'other' key will be appended using message 'htmlform-selectorother-other' if not already present.

Besides the parameters recognized by HTMLTextField, the following are recognized: options-messages - As for HTMLSelectField options - As for HTMLSelectField options-message - As for HTMLSelectField autocomplete-data - Associative array mapping display text to values. autocomplete-data-messages - Like autocomplete, but keys are message names. require-match - Boolean, if true the value must be in the options or the autocomplete. other-message - Message to use instead of htmlform-selectorother-other for the 'other' message. other - Raw text to use for the 'other' message

The old name of autocomplete-data[-messages] was autocomplete[-messages] which is still recognized but deprecated since MediaWiki 1.29 since it conflicts with how autocomplete is used in HTMLTextField.

Stable to extend

Definition at line 35 of file HTMLAutoCompleteSelectField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLAutoCompleteSelectField::__construct (   $params)

Stable to call Stable to call.

Parameters
array$params
  • type: HTML textfield type
  • size: field size in characters (defaults to 45)
  • placeholder/placeholder-message: set HTML placeholder attribute
  • spellcheck: set HTML spellcheck attribute
  • persistent: upon unsuccessful requests, retain the value (defaults to true, except for password fields)
.

Reimplemented from HTMLTextField.

Definition at line 42 of file HTMLAutoCompleteSelectField.php.

References HTMLFormField\getMessage(), HTMLFormField\getOptions(), HTMLFormField\msg(), and wfMessage().

Member Function Documentation

◆ getAttributes()

HTMLAutoCompleteSelectField::getAttributes ( array  $list)

Returns the given attributes from the parameters Stable to override.

Parameters
array$listList of attributes to get
Returns
array Attributes

Reimplemented from HTMLFormField.

Definition at line 130 of file HTMLAutoCompleteSelectField.php.

References FormatJson\encode(), and HTMLFormField\getOptions().

◆ getInputHTML()

HTMLAutoCompleteSelectField::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.
Stable to override Stable to override

Reimplemented from HTMLTextField.

Definition at line 145 of file HTMLAutoCompleteSelectField.php.

References HTMLFormField\$mClass, HTMLFormField\flattenOptions(), and HTMLFormField\getOptions().

◆ getInputOOUI()

HTMLAutoCompleteSelectField::getInputOOUI (   $value)

Get the OOUI version of this input.

Parameters
string$value
Returns
false

Reimplemented from HTMLTextField.

Definition at line 199 of file HTMLAutoCompleteSelectField.php.

◆ loadDataFromRequest()

HTMLAutoCompleteSelectField::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.

Stable to override

Parameters
WebRequest$request
Returns
mixed The value

Reimplemented from HTMLFormField.

Definition at line 92 of file HTMLAutoCompleteSelectField.php.

References HTMLFormField\getDefault().

◆ validate()

HTMLAutoCompleteSelectField::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 Stable to override

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.

Reimplemented from HTMLFormField.

Definition at line 109 of file HTMLAutoCompleteSelectField.php.

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

Member Data Documentation

◆ $autocompleteData

HTMLAutoCompleteSelectField::$autocompleteData = []
protected

Definition at line 36 of file HTMLAutoCompleteSelectField.php.


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