Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/form/ -> checkbox.php (source)

[Source view]

checkbox form element Contains HTML class for a checkbox type element

Copyright: 2007 Jamie Pratt <me@jamiep.org>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 153 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 lib/form/templatable_form_element.php

Defines 2 classes

MoodleQuickForm_checkbox:: (2 methods):
  __construct()
  MoodleQuickForm_checkbox()

name:: (5 methods):
  getHelpButton()
  onQuickFormEvent()
  toHtml()
  getFrozenHtml()
  export_for_template()


Class: MoodleQuickForm_checkbox  - X-Ref

HTML class for a checkbox type element

Overloaded {@link HTML_QuickForm_checkbox} to add help button. Also, fixes bug in quickforms
checkbox, which lets previous set value override submitted value if checkbox is not checked
and no value is submitted

__construct($elementName=null, $elementLabel=null, $text='', $attributes=null)   X-Ref
Constructor

param: string $elementName (optional) name of the checkbox
param: string $elementLabel (optional) checkbox label
param: string $text (optional) Text to put after the checkbox
param: mixed $attributes (optional) Either a typical HTML attribute string

MoodleQuickForm_checkbox($elementName=null, $elementLabel=null, $text='', $attributes=null)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

getHelpButton()   X-Ref
get html for help button

return: string html for help button

onQuickFormEvent($event, $arg, &$caller)   X-Ref
Called by HTML_QuickForm whenever form event is made on this element

param: string $event Name of event
param: mixed $arg event arguments
param: object $caller calling object
return: bool

toHtml()   X-Ref
Returns HTML for checbox form element.

return: string

getFrozenHtml()   X-Ref
Returns the disabled field. Accessibility: the return "[ ]" from parent
class is not acceptable for screenreader users, and we DO want a label.

return: string

export_for_template(renderer_base $output)   X-Ref
No description