lib/form/static.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  * 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/static.php");
  29 require_once('templatable_form_element.php');
  30
  31 /**
  32  * Text type element
  33  *
  34  * HTML class for a text type element
  35  *
  36  * @package   core_form
  37  * @category  form
  38  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40  */
  41 class MoodleQuickForm_static extends HTML_QuickForm_static implements templatable {
  42     use templatable_form_element {
  43         export_for_template as export_for_template_base;
  44     }
  45
  46     /** @var string Form element type */
  47     var $_elementTemplateType='static';
  48
  49     /** @var string html for help button, if empty then no help */
  50     var $_helpbutton='';
  51
  52     /**
  53      * constructor
  54      *
  55      * @param string $elementName (optional) name of the text field
  56      * @param string $elementLabel (optional) text field label
  57      * @param string $text (optional) Text to put in text field
  58      */
  59     public function __construct($elementName=null, $elementLabel=null, $text=null) {
  60         parent::__construct($elementName, $elementLabel, $text);
  61     }
  62
  63     /**
  64      * Old syntax of class constructor. Deprecated in PHP7.
  65      *
  66      * @deprecated since Moodle 3.1
  67      */
  68     public function MoodleQuickForm_static($elementName=null, $elementLabel=null, $text=null) {
  69         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  70         self::__construct($elementName, $elementLabel, $text);
  71     }
  72
  73     /**
  74      * get html for help button
  75      *
  76      * @return string html for help button
  77      */
  78     function getHelpButton(){
  79         return $this->_helpbutton;
  80     }
  81
  82     /**
  83      * Gets the type of form element
  84      *
  85      * @return string
  86      */
  87     function getElementTemplateType(){
  88         return $this->_elementTemplateType;
  89     }
  90
  91     public function export_for_template(renderer_base $output) {
  92         $context = $this->export_for_template_base($output);
  93         $context['html'] = $this->toHtml();
  94         $context['staticlabel'] = true;
  95         return $context;
  96     }
  97 }