Multi-select field. More...
Public Member Functions | |
| filterDataForSubmit ($data) | |
| Support for seperating multi-option preferences into multiple preferences Due to lack of array support. | |
| formatOptions ($options, $value) | |
| getDefault () | |
| getInputHTML ($value) | |
| This function must be implemented to return the HTML to generate the input object itself. | |
| loadDataFromRequest ($request) | |
| validate ($value, $alldata) | |
| Override this function to add specific validation checks on the field input. | |
Protected Member Functions | |
| needsLabel () | |
| Should this field have a label, or is there no input element with the appropriate id for the label to point to? | |
Detailed Description
Multi-select field.
Definition at line 2382 of file HTMLForm.php.
Member Function Documentation
Support for seperating multi-option preferences into multiple preferences Due to lack of array support.
- Parameters:
-
$data array
Implements HTMLNestedFilterable.
Definition at line 2475 of file HTMLForm.php.
| HTMLMultiSelectField::formatOptions | ( | $ | options, |
| $ | value | ||
| ) |
Definition at line 2413 of file HTMLForm.php.
References $html.
Reimplemented from HTMLFormField.
Definition at line 2467 of file HTMLForm.php.
| 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:
-
string $value the value to set the input to; eg a default text for a text input.
- Returns:
- String valid HTML.
Reimplemented from HTMLFormField.
Definition at line 2407 of file HTMLForm.php.
| HTMLMultiSelectField::loadDataFromRequest | ( | $ | request | ) |
- Parameters:
-
$request WebRequest
- Returns:
- String
Reimplemented from HTMLFormField.
Definition at line 2446 of file HTMLForm.php.
| 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?
- Returns:
- bool True to output a label, false to suppress
Reimplemented from HTMLFormField.
Definition at line 2486 of file HTMLForm.php.
| 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
- Parameters:
-
string $value the value the field was submitted with array $alldata the data collected from the form
- Returns:
- Mixed Bool true on success, or String error to display.
Reimplemented from HTMLFormField.
Reimplemented in EditWatchlistCheckboxSeriesField.
Definition at line 2384 of file HTMLForm.php.
References HTMLFormField\flattenOptions().
The documentation for this class was generated from the following file:
- includes/HTMLForm.php
