The checkbox-toggleall renderable class.
More...
|
bool | $isbutton |
| $isbutton Whether to render this as a button.
|
|
bool | $ismaster |
| $ismaster Whether we're rendering for a master checkbox or a slave checkbox.
|
|
array | $options |
| $options The options for the checkbox.
|
|
string | $togglegroup |
| The name of the group of checkboxes to be toggled.
|
|
The checkbox-toggleall renderable class.
- Copyright
- 2019 Jun Pataleta
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
core\output\checkbox_toggleall::__construct |
( |
string | $togglegroup, |
|
|
bool | $ismaster, |
|
|
| $options = [], |
|
|
| $isbutton = false ) |
Constructor.
- Parameters
-
string | $togglegroup | The name of the group of checkboxes to be toggled. |
bool | $ismaster | Whether we're rendering for a master checkbox or a slave checkbox. |
array | $options | The options for the checkbox. Valid options are:
-
id string - The element ID.
-
name string - The element name.
-
classes string - CSS classes that you want to add for your checkbox or toggle controls. For button type master toggle controls, this could be any Bootstrap 4 btn classes that you might want to add. Defaults to "btn-secondary".
-
value string|int - The element's value.
-
checked boolean - Whether to render this initially as checked.
-
label string - The label for the checkbox element.
-
labelclasses string - CSS classes that you want to add for your label.
-
selectall string - Master only. The language string that will be used to indicate that clicking on the master will select all of the slave checkboxes. Defaults to "Select all".
-
deselectall string - Master only. The language string that will be used to indicate that clicking on the master will select all of the slave checkboxes. Defaults to "Deselect all".
|
bool | $isbutton | Whether to render this as a button. Applies to master only. |
◆ export_for_template()
core\output\checkbox_toggleall::export_for_template |
( |
renderer_base | $output | ) |
|
Export for template.
- Parameters
-
- Return values
-
Implements templatable.
◆ get_template()
core\output\checkbox_toggleall::get_template |
( |
| ) |
|
Fetches the appropriate template for the checkbox toggle all element.
- Return values
-
◆ $isbutton
bool core\output\checkbox_toggleall::$isbutton |
|
protected |
$isbutton Whether to render this as a button.
Applies to master checkboxes only.
The documentation for this class was generated from the following file:
- lib/classes/output/checkbox_toggleall.php