lib/form/radio.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 /**
  19  * radio type form element
  20  *
  21  * Contains HTML class for a radio type element
  22  *
  23  * @package   core_form
  24  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 require_once('HTML/QuickForm/radio.php');
  29
  30 /**
  31  * radio type form element
  32  *
  33  * HTML class for a radio type element
  34  *
  35  * @package   core_form
  36  * @category  form
  37  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class MoodleQuickForm_radio extends HTML_QuickForm_radio{
  41     /** @var string html for help button, if empty then no help */
  42     var $_helpbutton='';
  43
  44     /**
  45      * constructor
  46      *
  47      * @param string $elementName (optional) name of the radio element
  48      * @param string $elementLabel (optional) label for radio element
  49      * @param string $text (optional) Text to put after the radio element
  50      * @param string $value (optional) default value
  51      * @param mixed $attributes (optional) Either a typical HTML attribute string
  52      *              or an associative array
  53      */
  54     function MoodleQuickForm_radio($elementName=null, $elementLabel=null, $text=null, $value=null, $attributes=null) {
  55         parent::HTML_QuickForm_radio($elementName, $elementLabel, $text, $value, $attributes);
  56     }
  57
  58     /**
  59      * get html for help button
  60      *
  61      * @return string html for help button
  62      */
  63     function getHelpButton(){
  64         return $this->_helpbutton;
  65     }
  66
  67     /**
  68      * Slightly different container template when frozen.
  69      *
  70      * @return string
  71      */
  72     function getElementTemplateType(){
  73         if ($this->_flagFrozen){
  74             return 'static';
  75         } else {
  76             return 'default';
  77         }
  78     }
  79
  80     /**
  81      * Returns the disabled field. Accessibility: the return "( )" from parent
  82      * class is not acceptable for screenreader users, and we DO want a label.
  83      *
  84      * @return string
  85      */
  86     function getFrozenHtml()
  87     {
  88         $output = '<input type="radio" disabled="disabled" id="'.$this->getAttribute('id').'" ';
  89         if ($this->getChecked()) {
  90             $output .= 'checked="checked" />'.$this->_getPersistantData();
  91         } else {
  92             $output .= '/>';
  93         }
  94         return $output;
  95     }
  96
  97     /**
  98      * Returns HTML for advchecbox form element.
  99      *
 100      * @return string
 101      */
 102     function toHtml()
 103     {
 104         return '<span>' . parent::toHtml() . '</span>';
 105     }
 106 }