The checkbox-toggleall renderable class. More...

Inheritance diagram for core\output\checkbox_toggleall:

Public Member Functions
	__construct (string $togglegroup, bool $ismaster, $options=[], $isbutton=false)
	Constructor.

	export_for_template (renderer_base $output)
	Export for template.

	get_template ()
	Fetches the appropriate template for the checkbox toggle all element.

Protected Attributes
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.

Detailed Description

The checkbox-toggleall renderable class.

Constructor & Destructor Documentation

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.

core\output\checkbox_toggleall::export_for_template ( renderer_base $output )

Export for template.

Parameters

renderer_base $output The renderer.

Return values

stdClass

Implements templatable.

core\output\checkbox_toggleall::get_template ( )

Fetches the appropriate template for the checkbox toggle all element.

Return values

string

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: