[Summary view] [Print] [Text view]

   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      public function __construct($elementName=null, $elementLabel=null, $text=null, $value=null, $attributes=null) {
  55          parent::__construct($elementName, $elementLabel, $text, $value, $attributes);
  56      }
  57  
  58      /**
  59       * Old syntax of class constructor. Deprecated in PHP7.
  60       *
  61       * @deprecated since Moodle 3.1
  62       */
  63      public function MoodleQuickForm_radio($elementName=null, $elementLabel=null, $text=null, $value=null, $attributes=null) {
  64          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  65          self::__construct($elementName, $elementLabel, $text, $value, $attributes);
  66      }
  67  
  68      /**
  69       * get html for help button
  70       *
  71       * @return string html for help button
  72       */
  73      function getHelpButton(){
  74          return $this->_helpbutton;
  75      }
  76  
  77      /**
  78       * Slightly different container template when frozen.
  79       *
  80       * @return string
  81       */
  82      function getElementTemplateType(){
  83          if ($this->_flagFrozen){
  84              return 'static';
  85          } else {
  86              return 'default';
  87          }
  88      }
  89  
  90      /**
  91       * Returns the disabled field. Accessibility: the return "( )" from parent
  92       * class is not acceptable for screenreader users, and we DO want a label.
  93       *
  94       * @return string
  95       */
  96      function getFrozenHtml()
  97      {
  98          $output = '<input type="radio" disabled="disabled" id="'.$this->getAttribute('id').'" ';
  99          if ($this->getChecked()) {
 100              $output .= 'checked="checked" />'.$this->_getPersistantData();
 101          } else {
 102              $output .= '/>';
 103          }
 104          return $output;
 105      }
 106  
 107      /**
 108       * Returns HTML for advchecbox form element.
 109       *
 110       * @return string
 111       */
 112      function toHtml()
 113      {
 114          return '<span>' . parent::toHtml() . '</span>';
 115      }
 116  }