lib/form/hidden.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  * Hidden type form element
  20  *
  21  * Contains HTML class for a hidden 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/hidden.php');
  29
  30 /**
  31  * Hidden type form element
  32  *
  33  * HTML class for a hidden 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_hidden extends HTML_QuickForm_hidden{
  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 hidden element
  48      * @param string $value (optional) value of the element
  49      * @param mixed  $attributes (optional) Either a typical HTML attribute string
  50      *               or an associative array
  51      */
  52     public function __construct($elementName=null, $value='', $attributes=null) {
  53         parent::__construct($elementName, $value, $attributes);
  54     }
  55
  56     /**
  57      * Old syntax of class constructor. Deprecated in PHP7.
  58      *
  59      * @deprecated since Moodle 3.1
  60      */
  61     public function MoodleQuickForm_hidden($elementName=null, $value='', $attributes=null) {
  62         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  63         return self::__construct($elementName, $value, $attributes);
  64     }
  65
  66     /**
  67      * @deprecated since Moodle 2.0
  68      */
  69     function setHelpButton($helpbuttonargs, $function='helpbutton'){
  70         throw new coding_exception('setHelpButton() can not be used any more, please see MoodleQuickForm::addHelpButton().');
  71     }
  72
  73     /**
  74      * get html for help button
  75      *
  76      * @return string html for help button
  77      */
  78     function getHelpButton(){
  79         return '';
  80     }
  81 }