. /** * The renderable for core/checkbox-toggleall. * * @package core * @copyright 2019 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\output; defined('MOODLE_INTERNAL') || die(); use renderable; use renderer_base; use stdClass; use templatable; /** * The checkbox-toggleall renderable class. * * @package core * @copyright 2019 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class checkbox_toggleall implements renderable, templatable { /** @var string The name of the group of checkboxes to be toggled. */ protected $togglegroup; /** @var bool $ismaster Whether we're rendering for a master checkbox or a slave checkbox. */ protected $ismaster; /** @var array $options The options for the checkbox. */ protected $options; /** @var bool $isbutton Whether to render this as a button. Applies to master checkboxes only. */ protected $isbutton; /** * Constructor. * * @param string $togglegroup The name of the group of checkboxes to be toggled. * @param bool $ismaster Whether we're rendering for a master checkbox or a slave checkbox. * @param 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".
*

* @param bool $isbutton Whether to render this as a button. Applies to master only. */ public function __construct(string $togglegroup, bool $ismaster, $options = [], $isbutton = false) { $this->togglegroup = $togglegroup; $this->ismaster = $ismaster; $this->options = $options; $this->isbutton = $ismaster && $isbutton; } /** * Export for template. * * @param renderer_base $output The renderer. * @return stdClass */ public function export_for_template(renderer_base $output) { $data = (object)[ 'togglegroup' => $this->togglegroup, 'id' => $this->options['id'] ?? null, 'name' => $this->options['name'] ?? null, 'value' => $this->options['value'] ?? null, 'classes' => $this->options['classes'] ?? null, 'label' => $this->options['label'] ?? null, 'labelclasses' => $this->options['labelclasses'] ?? null, 'checked' => $this->options['checked'] ?? false, ]; if ($this->ismaster) { $data->selectall = $this->options['selectall'] ?? get_string('selectall'); $data->deselectall = $this->options['deselectall'] ?? get_string('deselectall'); } return $data; } /** * Fetches the appropriate template for the checkbox toggle all element. * * @return string */ public function get_template() { if ($this->ismaster) { if ($this->isbutton) { return 'core/checkbox-toggleall-master-button'; } else { return 'core/checkbox-toggleall-master'; } } return 'core/checkbox-toggleall-slave'; } }