Radio checkbox fields. More...
Public Member Functions | |
| formatOptions ( $options, $value) | |
| getInputHTML ( $value) | |
| This returns a block of all the radio options, in one cell. More... | |
| validate ( $value, $alldata) | |
| Override this function to add specific validation checks on the field input. More... | |
 Public Member Functions inherited from HTMLFormField | |
| __construct ( $params) | |
| Initialise the object. More... | |
| filter ( $value, $alldata) | |
| getAttributes (array $list) | |
| Returns the given attributes from the parameters. More... | |
| getDefault () | |
| 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... | |
| getHelpText () | |
| Determine the help text to display. 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... | |
| getLabel () | |
| getLabelHtml ( $cellAttributes=array()) | |
| getOptions () | |
| Fetch the array of options from the field's parameters. 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. 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... | |
| msg () | |
| Get a translated interface message. More... | |
| setShowEmptyLabel ( $show) | |
| Tell the field whether to generate a separate label element if its label is blank. More... | |
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? More... | |
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 | |
| $mParams | |
| HTMLForm | $mParent |
| Static Protected Member Functions inherited from HTMLFormField | |
| static | formatErrors ( $errors) |
| Formats one or more errors as accepted by field validation-callback. More... | |
| Protected Attributes inherited from HTMLFormField | |
| $mClass = '' | |
| $mDefault | |
| $mFilterCallback | |
| $mID | |
| $mLabel | |
| $mName | |
| $mOptions = false | |
| $mOptionsLabelsNotFromMessage = false | |
| bool | $mShowEmptyLabels = true |
| If true will generate an empty div element with no label. More... | |
| $mValidationCallback | |
Detailed Description
Radio checkbox fields.
Definition at line 6 of file HTMLRadioField.php.
Member Function Documentation
◆ formatOptions()
| HTMLRadioField::formatOptions | ( | $options, | |
| $value | |||
| ) |
Definition at line 41 of file HTMLRadioField.php.
References $attribs, $html, $options, $value, array(), as, Sanitizer\escapeId(), HTMLFormField\getAttributes(), Xml\radio(), and Html\rawElement().
Referenced by getInputHTML().
◆ getInputHTML()
| 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 35 of file HTMLRadioField.php.
References $html, $value, formatOptions(), and HTMLFormField\getOptions().
◆ 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 68 of file HTMLRadioField.php.
◆ validate()
| 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 7 of file HTMLRadioField.php.
References $value, HTMLFormField\flattenOptions(), HTMLFormField\getOptions(), and HTMLFormField\msg().
The documentation for this class was generated from the following file:
- includes/htmlform/HTMLRadioField.php
