[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   * Text type form element
  20   *
  21   * Contains HTML class for a text 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/text.php");
  29  
  30  /**
  31   * Text type form element
  32   *
  33   * HTML class for a text 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_text extends HTML_QuickForm_text{
  41      /** @var string html for help button, if empty then no help */
  42      var $_helpbutton='';
  43  
  44      /** @var bool if true label will be hidden */
  45      var $_hiddenLabel=false;
  46  
  47      /**
  48       * constructor
  49       *
  50       * @param string $elementName (optional) name of the text field
  51       * @param string $elementLabel (optional) text field label
  52       * @param string $attributes (optional) Either a typical HTML attribute string or an associative array
  53       */
  54      public function __construct($elementName=null, $elementLabel=null, $attributes=null) {
  55          parent::__construct($elementName, $elementLabel, $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_text($elementName=null, $elementLabel=null, $attributes=null) {
  64          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  65          self::__construct($elementName, $elementLabel, $attributes);
  66      }
  67  
  68      /**
  69       * Sets label to be hidden
  70       *
  71       * @param bool $hiddenLabel sets if label should be hidden
  72       */
  73      function setHiddenLabel($hiddenLabel){
  74          $this->_hiddenLabel = $hiddenLabel;
  75      }
  76  
  77      /**
  78       * Freeze the element so that only its value is returned and set persistantfreeze to false
  79       *
  80       * @since     Moodle 2.4
  81       * @access    public
  82       * @return    void
  83       */
  84      function freeze()
  85      {
  86          $this->_flagFrozen = true;
  87          // No hidden element is needed refer MDL-30845
  88          $this->setPersistantFreeze(false);
  89      } //end func freeze
  90  
  91      /**
  92       * Returns the html to be used when the element is frozen
  93       *
  94       * @since     Moodle 2.4
  95       * @return    string Frozen html
  96       */
  97      function getFrozenHtml()
  98      {
  99          $attributes = array('readonly' => 'readonly');
 100          $this->updateAttributes($attributes);
 101          return $this->_getTabs() . '<input' . $this->_getAttrString($this->_attributes) . ' />' . $this->_getPersistantData();
 102      } //end func getFrozenHtml
 103  
 104      /**
 105       * Returns HTML for this form element.
 106       *
 107       * @return string
 108       */
 109      function toHtml(){
 110          if ($this->_hiddenLabel){
 111              $this->_generateId();
 112              return '<label class="accesshide" for="'.$this->getAttribute('id').'" >'.
 113                          $this->getLabel().'</label>'.parent::toHtml();
 114          } else {
 115               return parent::toHtml();
 116          }
 117      }
 118  
 119      /**
 120       * get html for help button
 121       *
 122       * @return string html for help button
 123       */
 124      function getHelpButton(){
 125          return $this->_helpbutton;
 126      }
 127  }