[Summary view] [Print] [Text view]

   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  
  30  /**
  31   * HTML class for a button type element
  32   *
  33   * Overloaded {@link HTML_QuickForm_button} to add help button
  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_button extends HTML_QuickForm_button
  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 (optional) name for the button
  49       * @param string $value (optional) value for the button
  50       * @param mixed $attributes (optional) Either a typical HTML attribute string
  51       *              or an associative array
  52       */
  53      public function __construct($elementName=null, $value=null, $attributes=null) {
  54          parent::__construct($elementName, $value, $attributes);
  55      }
  56  
  57      /**
  58       * Old syntax of class constructor. Deprecated in PHP7.
  59       *
  60       * @deprecated since Moodle 3.1
  61       */
  62      public function MoodleQuickForm_button($elementName=null, $value=null, $attributes=null) {
  63          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  64          self::__construct($elementName, $value, $attributes);
  65      }
  66  
  67      /**
  68       * get html for help button
  69       *
  70       * @return string html for help button
  71       */
  72      function getHelpButton(){
  73          return $this->_helpbutton;
  74      }
  75  
  76      /**
  77       * Slightly different container template when frozen.
  78       *
  79       * @return string
  80       */
  81      function getElementTemplateType(){
  82          if ($this->_flagFrozen){
  83              return 'nodisplay';
  84          } else {
  85              return 'default';
  86          }
  87      }
  88  }