lib/form/header.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  * Header form element
  20  *
  21  * Contains a pseudo-element used for adding headers to form
  22  *
  23  * @package   core_form
  24  * @copyright 2007 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/header.php';
  29
  30 /**
  31  * Header form element
  32  *
  33  * A pseudo-element used for adding headers to form
  34  *
  35  * @package   core_form
  36  * @category  form
  37  * @copyright 2007 Jamie Pratt <me@jamiep.org>
  38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class MoodleQuickForm_header extends HTML_QuickForm_header
  41 {
  42     /** @var string html for help button, if empty then no help */
  43     var $_helpbutton='';
  44
  45     /**
  46      * constructor
  47      *
  48      * @param string $elementName name of the header element
  49      * @param string $text text displayed in header element
  50      */
  51     public function __construct($elementName = null, $text = null) {
  52         parent::__construct($elementName, $text);
  53     }
  54
  55     /**
  56      * Old syntax of class constructor. Deprecated in PHP7.
  57      *
  58      * @deprecated since Moodle 3.1
  59      */
  60     public function MoodleQuickForm_header($elementName = null, $text = null) {
  61         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  62         self::__construct($elementName, $text);
  63     }
  64
  65    /**
  66     * Accepts a renderer
  67     *
  68     * @param HTML_QuickForm_Renderer $renderer a HTML_QuickForm_Renderer object
  69     */
  70     function accept(&$renderer, $required=false, $error=null)
  71     {
  72         $this->_text .= $this->getHelpButton();
  73         $renderer->renderHeader($this);
  74     }
  75
  76     /**
  77      * get html for help button
  78      *
  79      * @return string html for help button
  80      */
  81     function getHelpButton(){
  82         return $this->_helpbutton;
  83     }
  84 }