Radio checkbox fields. More...
Public Member Functions | |
| formatOptions ($options, $value) | |
| getInputHTML ($value) | |
| This returns a block of all the radio options, in one cell. | |
| 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
Radio checkbox fields.
Definition at line 2663 of file HTMLForm.php.
Member Function Documentation
| HTMLRadioField::formatOptions | ( | $ | options, |
| $ | value | ||
| ) |
Definition at line 2697 of file HTMLForm.php.
References $html.
| HTMLRadioField::getInputHTML | ( | $ | value | ) |
This returns a block of all the radio options, in one cell.
- See also:
- includes/HTMLFormFieldgetInputHTML()
- Parameters:
-
$value String
- Returns:
- String
Reimplemented from HTMLFormField.
Definition at line 2691 of file HTMLForm.php.
| HTMLRadioField::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 2728 of file HTMLForm.php.
| HTMLRadioField::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.
Definition at line 2665 of file HTMLForm.php.
References HTMLFormField\flattenOptions(), and HTMLFormField\msg().
The documentation for this class was generated from the following file:
- includes/HTMLForm.php
