lib/form/advcheckbox.php

   1 <?php
   2 require_once('HTML/QuickForm/advcheckbox.php');
   3
   4 /**
   5  * HTML class for a advcheckbox type element
   6  *
   7  * default behavior special for Moodle is to return '0' if not checked
   8  * '1' for checked.
   9  *
  10  * * @author       Jamie Pratt
  11  * @access       public
  12  */
  13 class MoodleQuickForm_advcheckbox extends HTML_QuickForm_advcheckbox{
  14     /**
  15      * html for help button, if empty then no help
  16      *
  17      * @var string
  18      */
  19     var $_helpbutton='';
  20
  21     /**
  22      * Group to which this checkbox belongs (for select all/select none button)
  23      * @var string $_group
  24      */
  25     var $_group;
  26
  27     /**
  28      * Class constructor
  29      *
  30      * @param     string    $elementName    (optional)Input field name attribute
  31      * @param     string    $elementLabel   (optional)Input field label
  32      * @param     string    $text           (optional)Text to put after the checkbox
  33      * @param     mixed     $attributes     (optional)Either a typical HTML attribute string
  34      *                                      or an associative array
  35      * @param     mixed     $values         (optional)Values to pass if checked or not checked
  36      *
  37      * @since     1.0
  38      * @access    public
  39      * @return    void
  40      */
  41     function MoodleQuickForm_advcheckbox($elementName=null, $elementLabel=null, $text=null, $attributes=null, $values=null)
  42     {
  43         if ($values === null){
  44             $values = array(0, 1);
  45         }
  46
  47         if (!is_null($attributes['group'])) {
  48
  49             $this->_group = 'checkboxgroup' . $attributes['group'];
  50             unset($attributes['group']);
  51             if (is_null($attributes)) {
  52                 $attributes = array();
  53                 $attributes['class'] .= " $this->_group";
  54             } elseif (is_array($attributes)) {
  55                 if (isset($attributes['class'])) {
  56                     $attributes['class'] .= " $this->_group";
  57                 } else {
  58                     $attributes['class'] = $this->_group;
  59                 }
  60             } elseif ($strpos = stripos($attributes, 'class="')) {
  61                 $attributes = str_ireplace('class="', 'class="' . $this->_group . ' ', $attributes);
  62             } else {
  63                 $attributes .= ' class="' . $this->_group . '"';
  64             }
  65         }
  66
  67         parent::HTML_QuickForm_advcheckbox($elementName, $elementLabel, $text, $attributes, $values);
  68     } //end constructor
  69
  70
  71     /**
  72      * set html for help button
  73      *
  74      * @access   public
  75      * @param array $help array of arguments to make a help button
  76      * @param string $function function name to call to get html
  77      */
  78     function setHelpButton($helpbuttonargs, $function='helpbutton'){
  79         if (!is_array($helpbuttonargs)){
  80             $helpbuttonargs=array($helpbuttonargs);
  81         }else{
  82             $helpbuttonargs=$helpbuttonargs;
  83         }
  84         //we do this to to return html instead of printing it
  85         //without having to specify it in every call to make a button.
  86         if ('helpbutton' == $function){
  87             $defaultargs=array('', '', 'moodle', true, false, '', true);
  88             $helpbuttonargs=$helpbuttonargs + $defaultargs ;
  89         }
  90         $this->_helpbutton=call_user_func_array($function, $helpbuttonargs);
  91     }
  92     /**
  93      * get html for help button
  94      *
  95      * @access   public
  96      * @return  string html for help button
  97      */
  98     function getHelpButton(){
  99         return $this->_helpbutton;
 100     }
 101    /**
 102     * Automatically generates and assigns an 'id' attribute for the element.
 103     *
 104     * Currently used to ensure that labels work on radio buttons and
 105     * advcheckboxes. Per idea of Alexander Radivanovich.
 106     * Overriden in moodleforms to remove qf_ prefix.
 107     *
 108     * @access private
 109     * @return void
 110     */
 111     function _generateId()
 112     {
 113         static $idx = 1;
 114
 115         if (!$this->getAttribute('id')) {
 116             $this->updateAttributes(array('id' => 'id_'.substr(md5(microtime() . $idx++), 0, 6)));
 117         }
 118     } // end func _generateId
 119
 120     function toHtml()
 121     {
 122         return '<span>' . parent::toHtml() . '</span>';
 123     }
 124
 125     /**
 126      * Returns the disabled field. Accessibility: the return "[ ]" from parent
 127      * class is not acceptable for screenreader users, and we DO want a label.
 128      * @return    string
 129      */
 130     function getFrozenHtml()
 131     {
 132         //$this->_generateId();
 133         $output = '<input type="checkbox" disabled="disabled" id="'.$this->getAttribute('id').'" ';
 134         if ($this->getChecked()) {
 135             $output .= 'checked="checked" />'.$this->_getPersistantData();
 136         } else {
 137             $output .= '/>';
 138         }
 139         return $output;
 140     } //end func getFrozenHtml
 141
 142 }
 143 ?>