[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   * Form element group
  20   *
  21   * Contains HTML class for group form 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/group.php");
  29  
  30  /**
  31   * HTML class for a form element group
  32   *
  33   * Overloaded {@link HTML_QuickForm_group} with default behavior modified for Moodle.
  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_group extends HTML_QuickForm_group{
  41      /** @var string html for help button, if empty then no help */
  42      var $_helpbutton='';
  43  
  44      /**
  45       * constructor
  46       *
  47       * @param string $elementName (optional) name of the group
  48       * @param string $elementLabel (optional) group label
  49       * @param array $elements (optional) array of HTML_QuickForm_element elements to group
  50       * @param string $separator (optional) string to seperate elements.
  51       * @param string $appendName (optional) string to appened to grouped elements.
  52       */
  53      public function __construct($elementName=null, $elementLabel=null, $elements=null, $separator=null, $appendName = true) {
  54          parent::__construct($elementName, $elementLabel, $elements, $separator, $appendName);
  55      }
  56  
  57      /**
  58       * Old syntax of class constructor. Deprecated in PHP7.
  59       *
  60       * @deprecated since Moodle 3.1
  61       */
  62      public function MoodleQuickForm_group($elementName=null, $elementLabel=null, $elements=null, $separator=null, $appendName = true) {
  63          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
  64          self::__construct($elementName, $elementLabel, $elements, $separator, $appendName);
  65      }
  66  
  67      /** @var string template type, would cause problems with client side validation so will leave for now */
  68      //var $_elementTemplateType='fieldset';
  69  
  70      /**
  71       * set html for help button
  72       */
  73      function getHelpButton(){
  74          return $this->_helpbutton;
  75      }
  76  
  77      /**
  78       * Returns element template, nodisplay/static/fieldset
  79       *
  80       * @return string
  81       */
  82      function getElementTemplateType(){
  83          if ($this->_flagFrozen){
  84              if ($this->getGroupType() == 'submit'){
  85                  return 'nodisplay';
  86              } else {
  87                  return 'static';
  88              }
  89          } else {
  90              if ($this->getGroupType() == 'submit') {
  91                  return 'actionbuttons';
  92              }
  93              return 'fieldset';
  94          }
  95      }
  96  
  97      /**
  98       * Sets the grouped elements and hides label
  99       *
 100       * @param array $elements
 101       */
 102      function setElements($elements){
 103          parent::setElements($elements);
 104          foreach ($this->_elements as $element){
 105              if (method_exists($element, 'setHiddenLabel')){
 106                  $element->setHiddenLabel(true);
 107              }
 108          }
 109      }
 110  }