[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   * Textarea type form element
  20   *
  21   * Contains HTML class for a textarea type element
  22   *
  23   * @package   core_form
  24   * @copyright 2006 Jamie Pratt <[email protected]>
  25   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26   */
  27  
  28  require_once('HTML/QuickForm/textarea.php');
  29  
  30  /**
  31   * Textarea type form element
  32   *
  33   * HTML class for a textarea type element
  34   *
  35   * @package   core_form
  36   * @category  form
  37   * @copyright 2006 Jamie Pratt <[email protected]>
  38   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class MoodleQuickForm_textarea extends HTML_QuickForm_textarea{
  41      /** @var string Need to store id of form as we may need it for helpbutton */
  42      var $_formid = '';
  43  
  44      /** @var string html for help button, if empty then no help */
  45      var $_helpbutton='';
  46  
  47      /** @var bool if true label will be hidden */
  48      var $_hiddenLabel=false;
  49  
  50      /**
  51       * constructor
  52       *
  53       * @param string $elementName (optional) name of the text field
  54       * @param string $elementLabel (optional) text field label
  55       * @param string $attributes (optional) Either a typical HTML attribute string or an associative array
  56       */
  57      function MoodleQuickForm_textarea($elementName=null, $elementLabel=null, $attributes=null) {
  58          parent::HTML_QuickForm_textarea($elementName, $elementLabel, $attributes);
  59      }
  60  
  61      /**
  62       * get html for help button
  63       *
  64       * @return string html for help button
  65       */
  66      function getHelpButton(){
  67          return $this->_helpbutton;
  68      }
  69  
  70      /**
  71       * Sets label to be hidden
  72       *
  73       * @param bool $hiddenLabel sets if label should be hidden
  74       */
  75      function setHiddenLabel($hiddenLabel){
  76          $this->_hiddenLabel = $hiddenLabel;
  77      }
  78  
  79      /**
  80       * Returns HTML for this form element.
  81       *
  82       * @return string
  83       */
  84      function toHtml(){
  85          if ($this->_hiddenLabel){
  86              $this->_generateId();
  87              return '<label class="accesshide" for="' . $this->getAttribute('id') . '" >' .
  88                      $this->getLabel() . '</label>' . parent::toHtml();
  89          } else {
  90              return parent::toHtml();
  91          }
  92      }
  93  
  94      /**
  95       * Called by HTML_QuickForm whenever form event is made on this element
  96       *
  97       * @param string $event Name of event
  98       * @param mixed $arg event arguments
  99       * @param object $caller calling object
 100       */
 101      function onQuickFormEvent($event, $arg, &$caller)
 102      {
 103          switch ($event) {
 104              case 'createElement':
 105                  $this->_formid = $caller->getAttribute('id');
 106                  break;
 107          }
 108          return parent::onQuickFormEvent($event, $arg, $caller);
 109      }
 110  
 111      /**
 112       * Slightly different container template when frozen.
 113       *
 114       * @return string
 115       */
 116      function getElementTemplateType(){
 117          if ($this->_flagFrozen){
 118              return 'static';
 119          } else {
 120              return 'default';
 121          }
 122      }
 123  }