A select dropdown field. More...
Public Member Functions | |
| getInputHTML ($value) | |
| This function must be implemented to return the HTML to generate the input object itself. | |
| validate ($value, $alldata) | |
| Override this function to add specific validation checks on the field input. | |
Detailed Description
A select dropdown field.
Basically a wrapper for Xmlselect class
Definition at line 6 of file HTMLSelectField.php.
Member Function Documentation
| 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:
-
string $value The value to set the input to; eg a default text for a text input.
- Returns:
- string Valid HTML.
Reimplemented from HTMLFormField.
Reimplemented in HTMLSelectAndOtherField.
Definition at line 23 of file HTMLSelectField.php.
References $name, $value, array(), as, empty, HTMLFormField\getAttributes(), and HTMLFormField\getOptions().
| 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
- Parameters:
-
string | array $value The value the field was submitted with array $alldata The data collected from the form
- Returns:
- bool|string True on success, or String error to display, or false to fail validation without displaying an error.
Reimplemented from HTMLFormField.
Reimplemented in HTMLSelectAndOtherField, and HTMLSelectLimitField.
Definition at line 7 of file HTMLSelectField.php.
References $value, HTMLFormField\flattenOptions(), HTMLFormField\getOptions(), and HTMLFormField\msg().
The documentation for this class was generated from the following file:
- includes/htmlform/HTMLSelectField.php
