lib/form/checkbox.php

   1 <?php
   2 require_once('HTML/QuickForm/checkbox.php');
   3
   4 /**
   5  * HTML class for a checkbox type element
   6  *
   7  * @author       Jamie Pratt
   8  * @access       public
   9  */
  10 class MoodleQuickForm_checkbox extends HTML_QuickForm_checkbox{
  11     /**
  12      * html for help button, if empty then no help
  13      *
  14      * @var string
  15      */
  16     var $_helpbutton='';
  17     /**
  18      * set html for help button
  19      *
  20      * @access   public
  21      * @param array $help array of arguments to make a help button
  22      * @param string $function function name to call to get html
  23      */
  24     function setHelpButton($helpbuttonargs, $function='helpbutton'){
  25         if (!is_array($helpbuttonargs)){
  26             $helpbuttonargs=array($helpbuttonargs);
  27         }else{
  28             $helpbuttonargs=$helpbuttonargs;
  29         }
  30         //we do this to to return html instead of printing it
  31         //without having to specify it in every call to make a button.
  32         if ('helpbutton' == $function){
  33             $defaultargs=array('', '', 'moodle', true, false, '', true);
  34             $helpbuttonargs=$helpbuttonargs + $defaultargs ;
  35         }
  36         $this->_helpbutton=call_user_func_array($function, $helpbuttonargs);
  37     }
  38     /**
  39      * get html for help button
  40      *
  41      * @access   public
  42      * @return  string html for help button
  43      */
  44     function getHelpButton(){
  45         return $this->_helpbutton;
  46     }
  47    /**
  48     * Automatically generates and assigns an 'id' attribute for the element.
  49     *
  50     * Currently used to ensure that labels work on radio buttons and
  51     * checkboxes. Per idea of Alexander Radivanovich.
  52     * Overriden in moodleforms to remove qf_ prefix.
  53     *
  54     * @access private
  55     * @return void
  56     */
  57     function _generateId()
  58     {
  59         static $idx = 1;
  60
  61         if (!$this->getAttribute('id')) {
  62             $this->updateAttributes(array('id' => 'id_'.substr(md5(microtime() . $idx++), 0, 6)));
  63         }
  64     } // end func _generateId
  65     /**
  66      * Called by HTML_QuickForm whenever form event is made on this element
  67      *
  68      * @param     string    $event  Name of event
  69      * @param     mixed     $arg    event arguments
  70      * @param     object    $caller calling object
  71      * @since     1.0
  72      * @access    public
  73      * @return    void
  74      */
  75     function onQuickFormEvent($event, $arg, &$caller)
  76     {
  77         //fixes bug in quickforms which lets previous set value override submitted value if checkbox is not checked
  78         // and no value is submitted
  79         switch ($event) {
  80             case 'updateValue':
  81                 // constant values override both default and submitted ones
  82                 // default values are overriden by submitted
  83                 $value = $this->_findValue($caller->_constantValues);
  84                 if (null === $value) {
  85                     // if no boxes were checked, then there is no value in the array
  86                     // yet we don't want to display default value in this case
  87                     if ($caller->isSubmitted()) {
  88                         $value = $this->_findValue($caller->_submitValues);
  89                     } else {
  90
  91                         $value = $this->_findValue($caller->_defaultValues);
  92                     }
  93                 }
  94                 //fix here. setChecked should not be conditional
  95                 $this->setChecked($value);
  96                 break;
  97             default:
  98                 parent::onQuickFormEvent($event, $arg, $caller);
  99         }
 100         return true;
 101     } // end func onQuickFormEvent
 102     function toHtml()
 103     {
 104         return '<span>' . parent::toHtml() . '</span>';
 105     }
 106
 107     /**
 108      * Returns the disabled field. Accessibility: the return "[ ]" from parent
 109      * class is not acceptable for screenreader users, and we DO want a label.
 110      * @return    string
 111      */
 112     function getFrozenHtml()
 113     {
 114         //$this->_generateId();
 115         $output = '<input type="checkbox" disabled="disabled" id="'.$this->getAttribute('id').'" ';
 116         if ($this->getChecked()) {
 117             $output .= 'checked="checked" />'.$this->_getPersistantData();
 118         } else {
 119             $output .= '/>';
 120         }
 121         return $output;
 122     } //end func getFrozenHtml
 123 }
 124 ?>