[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   * Group of date input element
  20   *
  21   * Contains class for a group of elements used to input a date.
  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  global $CFG;
  29  require_once($CFG->libdir . '/form/group.php');
  30  require_once($CFG->libdir . '/formslib.php');
  31  
  32  /**
  33   * Class for a group of elements used to input a date.
  34   *
  35   * Emulates moodle print_date_selector function
  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_date_selector extends MoodleQuickForm_group {
  43  
  44      /**
  45       * Control the fieldnames for form elements.
  46       *
  47       * startyear => int start of range of years that can be selected
  48       * stopyear => int last year that can be selected
  49       * timezone => int|float|string (optional) timezone modifier used for edge case only.
  50       *      If not specified, then date is caclulated based on current user timezone.
  51       *      Note: dst will be calculated for string timezones only
  52       *      {@link http://docs.moodle.org/dev/Time_API#Timezone}
  53       * optional => if true, show a checkbox beside the date to turn it on (or off)
  54       * @var array
  55       */
  56      protected $_options = array();
  57  
  58      /**
  59       * @var array These complement separators, they are appended to the resultant HTML.
  60       */
  61      protected $_wrap = array('', '');
  62  
  63      /**
  64       * @var null|bool Keeps track of whether the date selector was initialised using createElement
  65       *                or addElement. If true, createElement was used signifying the element has been
  66       *                added to a group - see MDL-39187.
  67       */
  68      protected $_usedcreateelement = true;
  69  
  70      /**
  71       * constructor
  72       *
  73       * @param string $elementName Element's name
  74       * @param mixed $elementLabel Label(s) for an element
  75       * @param array $options Options to control the element's display
  76       * @param mixed $attributes Either a typical HTML attribute string or an associative array
  77       */
  78      public function __construct($elementName = null, $elementLabel = null, $options = array(), $attributes = null) {
  79          // Get the calendar type used - see MDL-18375.
  80          $calendartype = \core_calendar\type_factory::get_calendar_instance();
  81          $this->_options = array('startyear' => $calendartype->get_min_year(), 'stopyear' => $calendartype->get_max_year(),
  82              'defaulttime' => 0, 'timezone' => 99, 'step' => 5, 'optional' => false);
  83          // TODO MDL-52313 Replace with the call to parent::__construct().
  84          HTML_QuickForm_element::__construct($elementName, $elementLabel, $attributes);
  85          $this->_persistantFreeze = true;
  86          $this->_appendName = true;
  87          $this->_type = 'date_selector';
  88          // set the options, do not bother setting bogus ones
  89          if (is_array($options)) {
  90              foreach ($options as $name => $value) {
  91                  if (isset($this->_options[$name])) {
  92                      if (is_array($value) && is_array($this->_options[$name])) {
  93                          $this->_options[$name] = @array_merge($this->_options[$name], $value);
  94                      } else {
  95                          $this->_options[$name] = $value;
  96                      }
  97                  }
  98              }
  99          }
 100  
 101          // The YUI2 calendar only supports the gregorian calendar type.
 102          if ($calendartype->get_name() === 'gregorian') {
 103              form_init_date_js();
 104          }
 105      }
 106  
 107      /**
 108       * Old syntax of class constructor. Deprecated in PHP7.
 109       *
 110       * @deprecated since Moodle 3.1
 111       */
 112      public function MoodleQuickForm_date_selector($elementName = null, $elementLabel = null, $options = array(), $attributes = null) {
 113          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
 114          self::__construct($elementName, $elementLabel, $options, $attributes);
 115      }
 116  
 117      /**
 118       * This will create date group element constisting of day, month and year.
 119       *
 120       * @access private
 121       */
 122      function _createElements() {
 123          global $OUTPUT;
 124  
 125          // Get the calendar type used - see MDL-18375.
 126          $calendartype = \core_calendar\type_factory::get_calendar_instance();
 127  
 128          $this->_elements = array();
 129  
 130          $dateformat = $calendartype->get_date_order($this->_options['startyear'], $this->_options['stopyear']);
 131          foreach ($dateformat as $key => $value) {
 132              // E_STRICT creating elements without forms is nasty because it internally uses $this
 133              $this->_elements[] = @MoodleQuickForm::createElement('select', $key, get_string($key, 'form'), $value, $this->getAttributes(), true);
 134          }
 135          // The YUI2 calendar only supports the gregorian calendar type so only display the calendar image if this is being used.
 136          if ($calendartype->get_name() === 'gregorian') {
 137              $image = $OUTPUT->pix_icon('i/calendar', get_string('calendar', 'calendar'), 'moodle');
 138              $this->_elements[] = @MoodleQuickForm::createElement('link', 'calendar',
 139                      null, '#', $image,
 140                      array('class' => 'visibleifjs'));
 141          }
 142          // If optional we add a checkbox which the user can use to turn if on
 143          if ($this->_options['optional']) {
 144              $this->_elements[] = @MoodleQuickForm::createElement('checkbox', 'enabled', null, get_string('enable'), $this->getAttributes(), true);
 145          }
 146          foreach ($this->_elements as $element){
 147              if (method_exists($element, 'setHiddenLabel')){
 148                  $element->setHiddenLabel(true);
 149              }
 150          }
 151  
 152      }
 153  
 154      /**
 155       * Called by HTML_QuickForm whenever form event is made on this element
 156       *
 157       * @param string $event Name of event
 158       * @param mixed $arg event arguments
 159       * @param object $caller calling object
 160       * @return bool
 161       */
 162      function onQuickFormEvent($event, $arg, &$caller) {
 163          switch ($event) {
 164              case 'updateValue':
 165                  // Constant values override both default and submitted ones
 166                  // default values are overriden by submitted.
 167                  $value = $this->_findValue($caller->_constantValues);
 168                  if (null === $value) {
 169                      // If no boxes were checked, then there is no value in the array
 170                      // yet we don't want to display default value in this case.
 171                      if ($caller->isSubmitted()) {
 172                          $value = $this->_findValue($caller->_submitValues);
 173                      } else {
 174                          $value = $this->_findValue($caller->_defaultValues);
 175                      }
 176                  }
 177                  $requestvalue=$value;
 178                  if ($value == 0) {
 179                      $value = time();
 180                  }
 181                  if (!is_array($value)) {
 182                      $calendartype = \core_calendar\type_factory::get_calendar_instance();
 183                      $currentdate = $calendartype->timestamp_to_date_array($value, $this->_options['timezone']);
 184                      $value = array(
 185                          'day' => $currentdate['mday'],
 186                          'month' => $currentdate['mon'],
 187                          'year' => $currentdate['year']);
 188                      // If optional, default to off, unless a date was provided.
 189                      if ($this->_options['optional']) {
 190                          $value['enabled'] = $requestvalue != 0;
 191                      }
 192                  } else {
 193                      $value['enabled'] = isset($value['enabled']);
 194                  }
 195                  if (null !== $value) {
 196                      $this->setValue($value);
 197                  }
 198                  break;
 199              case 'createElement':
 200                  // Optional is an optional param, if its set we need to add a disabledIf rule.
 201                  // If its empty or not specified then its not an optional dateselector.
 202                  if (!empty($arg[2]['optional']) && !empty($arg[0])) {
 203                      // When using the function addElement, rather than createElement, we still
 204                      // enter this case, making this check necessary.
 205                      if ($this->_usedcreateelement) {
 206                          $caller->disabledIf($arg[0] . '[day]', $arg[0] . '[enabled]');
 207                          $caller->disabledIf($arg[0] . '[month]', $arg[0] . '[enabled]');
 208                          $caller->disabledIf($arg[0] . '[year]', $arg[0] . '[enabled]');
 209                      } else {
 210                          $caller->disabledIf($arg[0], $arg[0] . '[enabled]');
 211                      }
 212                  }
 213                  return parent::onQuickFormEvent($event, $arg, $caller);
 214                  break;
 215              case 'addElement':
 216                  $this->_usedcreateelement = false;
 217                  return parent::onQuickFormEvent($event, $arg, $caller);
 218                  break;
 219              default:
 220                  return parent::onQuickFormEvent($event, $arg, $caller);
 221          }
 222      }
 223  
 224      /**
 225       * Returns HTML for advchecbox form element.
 226       *
 227       * @return string
 228       */
 229      function toHtml() {
 230          include_once('HTML/QuickForm/Renderer/Default.php');
 231          $renderer = new HTML_QuickForm_Renderer_Default();
 232          $renderer->setElementTemplate('{element}');
 233          parent::accept($renderer);
 234  
 235          $html = $this->_wrap[0];
 236          if ($this->_usedcreateelement) {
 237              $html .= html_writer::tag('span', $renderer->toHtml(), array('class' => 'fdate_selector'));
 238          } else {
 239              $html .= $renderer->toHtml();
 240          }
 241          $html .= $this->_wrap[1];
 242  
 243          return $html;
 244      }
 245  
 246      /**
 247       * Accepts a renderer
 248       *
 249       * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
 250       * @param bool $required Whether a group is required
 251       * @param string $error An error message associated with a group
 252       */
 253      function accept(&$renderer, $required = false, $error = null) {
 254          $renderer->renderElement($this, $required, $error);
 255      }
 256  
 257      /**
 258       * Output a timestamp. Give it the name of the group.
 259       *
 260       * @param array $submitValues values submitted.
 261       * @param bool $assoc specifies if returned array is associative
 262       * @return array
 263       */
 264      function exportValue(&$submitValues, $assoc = false) {
 265          $value = null;
 266          $valuearray = array();
 267          foreach ($this->_elements as $element){
 268              $thisexport = $element->exportValue($submitValues[$this->getName()], true);
 269              if ($thisexport!=null){
 270                  $valuearray += $thisexport;
 271              }
 272          }
 273          if (count($valuearray)){
 274              if($this->_options['optional']) {
 275                  // If checkbox is on, the value is zero, so go no further
 276                  if(empty($valuearray['enabled'])) {
 277                      $value[$this->getName()] = 0;
 278                      return $value;
 279                  }
 280              }
 281              // Get the calendar type used - see MDL-18375.
 282              $calendartype = \core_calendar\type_factory::get_calendar_instance();
 283              $gregoriandate = $calendartype->convert_to_gregorian($valuearray['year'], $valuearray['month'], $valuearray['day']);
 284              $value[$this->getName()] = make_timestamp($gregoriandate['year'],
 285                                                        $gregoriandate['month'],
 286                                                        $gregoriandate['day'],
 287                                                        0, 0, 0,
 288                                                        $this->_options['timezone'],
 289                                                        true);
 290  
 291              return $value;
 292          } else {
 293              return null;
 294          }
 295      }
 296  }