Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/pear/HTML/QuickForm/ -> checkbox.php (source)

[Source view]

(no description)

File Size: 277 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

HTML_QuickForm_checkbox:: (2 methods):
  __construct()
  HTML_QuickForm_checkbox()

name:: (10 methods):
  setChecked()
  getChecked()
  toHtml()
  getFrozenHtml()
  setText()
  getText()
  setValue()
  getValue()
  onQuickFormEvent()
  exportValue()


Class: HTML_QuickForm_checkbox  - X-Ref

HTML class for a checkbox type field

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

param: string    $elementName    (optional)Input field name attribute
param: string    $elementLabel   (optional)Input field value
param: string    $text           (optional)Checkbox display text
param: mixed     $attributes     (optional)Either a typical HTML attribute string
return: void

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


Class: name  - X-Ref

setChecked($checked)   X-Ref
Sets whether a checkbox is checked

param: bool    $checked  Whether the field is checked or not
return: void

getChecked()   X-Ref
Returns whether a checkbox is checked

return: bool

toHtml()   X-Ref
Returns the checkbox element in HTML

return: string

getFrozenHtml()   X-Ref
Returns the value of field without HTML tags

return: string

setText($text)   X-Ref
Sets the checkbox text

param: string    $text  
return: void

getText()   X-Ref
Returns the checkbox text

return: string

setValue($value)   X-Ref
Sets the value of the form element

param: string    $value      Default value of the form element
return: void

getValue()   X-Ref
Returns the value of the form element

return: bool

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: void

exportValue(&$submitValues, $assoc = false)   X-Ref
Return true if the checkbox is checked, null if it is not checked (getValue() returns false)