[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

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