lib/form/button.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  * Button form element
  20  *
  21  * Contains HTML class for a button type element
  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/button.php");
  29 require_once(__DIR__ . '/../outputcomponents.php');
  30 require_once('templatable_form_element.php');
  31
  32 /**
  33  * HTML class for a button type element
  34  *
  35  * Overloaded {@link HTML_QuickForm_button} to add help button
  36  *
  37  * @package   core_form
  38  * @category  form
  39  * @copyright 2007 Jamie Pratt <me@jamiep.org>
  40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41  */
  42 class MoodleQuickForm_button extends HTML_QuickForm_button implements templatable
  43 {
  44     use templatable_form_element;
  45
  46     /** @var string html for help button, if empty then no help */
  47     var $_helpbutton='';
  48
  49     /**
  50      * constructor
  51      *
  52      * @param string $elementName (optional) name for the button
  53      * @param string $value (optional) value for the button
  54      * @param mixed $attributes (optional) Either a typical HTML attribute string
  55      *              or an associative array
  56      */
  57     public function __construct($elementName=null, $value=null, $attributes=null) {
  58         parent::__construct($elementName, $value, $attributes);
  59     }
  60
  61     /**
  62      * Old syntax of class constructor. Deprecated in PHP7.
  63      *
  64      * @deprecated since Moodle 3.1
  65      */
  66     public function MoodleQuickForm_button($elementName=null, $value=null, $attributes=null) {
  67         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  68         self::__construct($elementName, $value, $attributes);
  69     }
  70
  71     /**
  72      * get html for help button
  73      *
  74      * @return string html for help button
  75      */
  76     function getHelpButton(){
  77         return $this->_helpbutton;
  78     }
  79
  80     /**
  81      * Slightly different container template when frozen.
  82      *
  83      * @return string
  84      */
  85     function getElementTemplateType(){
  86         if ($this->_flagFrozen){
  87             return 'nodisplay';
  88         } else {
  89             return 'default';
  90         }
  91     }
  92 }