A checkbox field. More...
Public Member Functions | |
| getInputHTML ($value) | |
| This function must be implemented to return the HTML to generate the input object itself. | |
| getLabel () | |
| For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow() | |
| loadDataFromRequest ($request) | |
Protected Member Functions | |
| needsLabel () | |
| checkboxes don't need a label. | |
Detailed Description
A checkbox field.
Definition at line 6 of file HTMLCheckField.php.
Member Function Documentation
| HTMLCheckField::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 7 of file HTMLCheckField.php.
References $value, array(), Xml\check(), check, empty, HTMLFormField\getAttributes(), HTMLFormField\getTooltipAndAccessKey(), global, and Html\rawElement().
For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow()
- Returns:
- string
Reimplemented from HTMLFormField.
Definition at line 52 of file HTMLCheckField.php.
| HTMLCheckField::loadDataFromRequest | ( | $ | request | ) |
- Parameters:
-
WebRequest $request
- Returns:
- string
Reimplemented from HTMLFormField.
Definition at line 69 of file HTMLCheckField.php.
References HTMLFormField\getDefault().
| HTMLCheckField::needsLabel | ( | ) | [protected] |
checkboxes don't need a label.
- Returns:
- bool
Reimplemented from HTMLFormField.
Definition at line 60 of file HTMLCheckField.php.
The documentation for this class was generated from the following file:
- includes/htmlform/HTMLCheckField.php
