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     /** @var bool if true label will be hidden. */
  50     protected $_hiddenLabel = false;
  51
  52     /**
  53      * constructor
  54      *
  55      * @param string $elementName (optional) name for the button
  56      * @param string $value (optional) value for the button
  57      * @param mixed $attributes (optional) Either a typical HTML attribute string
  58      *              or an associative array
  59      */
  60     public function __construct($elementName=null, $value=null, $attributes=null) {
  61         parent::__construct($elementName, $value, $attributes);
  62     }
  63
  64     /**
  65      * Old syntax of class constructor. Deprecated in PHP7.
  66      *
  67      * @deprecated since Moodle 3.1
  68      */
  69     public function MoodleQuickForm_button($elementName=null, $value=null, $attributes=null) {
  70         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  71         self::__construct($elementName, $value, $attributes);
  72     }
  73
  74     /**
  75      * get html for help button
  76      *
  77      * @return string html for help button
  78      */
  79     function getHelpButton(){
  80         return $this->_helpbutton;
  81     }
  82
  83     /**
  84      * Slightly different container template when frozen.
  85      *
  86      * @return string
  87      */
  88     function getElementTemplateType(){
  89         if ($this->_flagFrozen){
  90             return 'nodisplay';
  91         } else {
  92             return 'default';
  93         }
  94     }
  95
  96     /**
  97      * Sets label to be hidden
  98      *
  99      * @param bool $hiddenLabel sets if label should be hidden
 100      */
 101     public function setHiddenLabel($hiddenLabel) {
 102         $this->_hiddenLabel = $hiddenLabel;
 103     }
 104 }