Merge branch 'MDL-66625-master' of git://github.com/rezaies/moodle
[moodle.git] / lib / form / datetimeselector.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/>.
18 /**
19  * Group of date and time input element
20  *
21  * Contains class for a group of elements used to input a date and time.
22  *
23  * @package   core_form
24  * @copyright 2006 Jamie Pratt <me@jamiep.org>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 global $CFG;
29 require_once($CFG->libdir . '/form/group.php');
30 require_once($CFG->libdir . '/formslib.php');
32 /**
33  * Element used to input a date and time.
34  *
35  * Class for a group of elements used to input a date and time.
36  *
37  * @package   core_form
38  * @category  form
39  * @copyright 2006 Jamie Pratt <me@jamiep.org>
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class MoodleQuickForm_date_time_selector extends MoodleQuickForm_group {
44     /**
45      * Options for the element.
46      *
47      * startyear => int start of range of years that can be selected
48      * stopyear => int last year that can be selected
49      * defaulttime => default time value if the field is currently not set
50      * timezone => int|float|string (optional) timezone modifier used for edge case only.
51      *      If not specified, then date is caclulated based on current user timezone.
52      *      Note: dst will be calculated for string timezones only
53      *      {@link http://docs.moodle.org/dev/Time_API#Timezone}
54      * step => step to increment minutes by
55      * optional => if true, show a checkbox beside the date to turn it on (or off)
56      * @var array
57      */
58     protected $_options = array();
60     /**
61      * @var array These complement separators, they are appended to the resultant HTML.
62      */
63     protected $_wrap = array('', '');
65     /**
66      * @var null|bool Keeps track of whether the date selector was initialised using createElement
67      *                or addElement. If true, createElement was used signifying the element has been
68      *                added to a group - see MDL-39187.
69      */
70     protected $_usedcreateelement = true;
72     /**
73      * Class constructor
74      *
75      * @param string $elementName Element's name
76      * @param mixed $elementLabel Label(s) for an element
77      * @param array $options Options to control the element's display
78      * @param mixed $attributes Either a typical HTML attribute string or an associative array
79      */
80     public function __construct($elementName = null, $elementLabel = null, $options = array(), $attributes = null) {
81         // Get the calendar type used - see MDL-18375.
82         $calendartype = \core_calendar\type_factory::get_calendar_instance();
83         $this->_options = array('startyear' => $calendartype->get_min_year(), 'stopyear' => $calendartype->get_max_year(),
84             'defaulttime' => 0, 'timezone' => 99, 'step' => 1, 'optional' => false);
86         // TODO MDL-52313 Replace with the call to parent::__construct().
87         HTML_QuickForm_element::__construct($elementName, $elementLabel, $attributes);
88         $this->_persistantFreeze = true;
89         $this->_appendName = true;
90         $this->_type = 'date_time_selector';
91         // set the options, do not bother setting bogus ones
92         if (is_array($options)) {
93             foreach ($options as $name => $value) {
94                 if (isset($this->_options[$name])) {
95                     if (is_array($value) && is_array($this->_options[$name])) {
96                         $this->_options[$name] = @array_merge($this->_options[$name], $value);
97                     } else {
98                         $this->_options[$name] = $value;
99                     }
100                 }
101             }
102         }
103     }
105     /**
106      * Old syntax of class constructor. Deprecated in PHP7.
107      *
108      * @deprecated since Moodle 3.1
109      */
110     public function MoodleQuickForm_date_time_selector($elementName = null, $elementLabel = null, $options = array(), $attributes = null) {
111         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
112         self::__construct($elementName, $elementLabel, $options, $attributes);
113     }
115     /**
116      * This will create date group element constisting of day, month and year.
117      *
118      * @access private
119      */
120     function _createElements() {
121         global $OUTPUT;
123         // Get the calendar type used - see MDL-18375.
124         $calendartype = \core_calendar\type_factory::get_calendar_instance();
126         for ($i = 0; $i <= 23; $i++) {
127             $hours[$i] = sprintf("%02d", $i);
128         }
129         for ($i = 0; $i < 60; $i += $this->_options['step']) {
130             $minutes[$i] = sprintf("%02d", $i);
131         }
133         $this->_elements = array();
134         $dateformat = $calendartype->get_date_order($this->_options['startyear'], $this->_options['stopyear']);
135         if (right_to_left()) {   // Display time to the right of date, in RTL mode.
136             $this->_elements[] = $this->createFormElement('select', 'minute', get_string('minute', 'form'),
137                 $minutes, $this->getAttributes(), true);
138             $this->_elements[] = $this->createFormElement('select', 'hour', get_string('hour', 'form'),
139                 $hours, $this->getAttributes(), true);
140             // Reverse date element (Should be: Day, Month, Year), in RTL mode.
141             $dateformat = array_reverse($dateformat);
142         }
143         foreach ($dateformat as $key => $date) {
144             // E_STRICT creating elements without forms is nasty because it internally uses $this
145             $this->_elements[] = $this->createFormElement('select', $key, get_string($key, 'form'), $date, $this->getAttributes(), true);
146         }
147         if (!right_to_left()) {   // Display time to the left of date, in LTR mode.
148             $this->_elements[] = $this->createFormElement('select', 'hour', get_string('hour', 'form'), $hours,
149                 $this->getAttributes(), true);
150             $this->_elements[] = $this->createFormElement('select', 'minute', get_string('minute', 'form'), $minutes,
151                 $this->getAttributes(), true);
152         }
153         // The YUI2 calendar only supports the gregorian calendar type so only display the calendar image if this is being used.
154         if ($calendartype->get_name() === 'gregorian') {
155             $image = $OUTPUT->pix_icon('i/calendar', get_string('calendar', 'calendar'), 'moodle');
156             $this->_elements[] = $this->createFormElement('link', 'calendar',
157                     null, '#', $image,
158                     array('class' => 'visibleifjs'));
159         }
160         // If optional we add a checkbox which the user can use to turn if on
161         if ($this->_options['optional']) {
162             $this->_elements[] = $this->createFormElement('checkbox', 'enabled', null, get_string('enable'), $this->getAttributes(), true);
163         }
164         foreach ($this->_elements as $element){
165             if (method_exists($element, 'setHiddenLabel')){
166                 $element->setHiddenLabel(true);
167             }
168         }
170     }
172     /**
173      * Called by HTML_QuickForm whenever form event is made on this element
174      *
175      * @param string $event Name of event
176      * @param mixed $arg event arguments
177      * @param object $caller calling object
178      * @return bool
179      */
180     function onQuickFormEvent($event, $arg, &$caller) {
181         $this->setMoodleForm($caller);
182         switch ($event) {
183             case 'updateValue':
184                 // Constant values override both default and submitted ones
185                 // default values are overriden by submitted.
186                 $value = $this->_findValue($caller->_constantValues);
187                 if (null === $value) {
188                     // If no boxes were checked, then there is no value in the array
189                     // yet we don't want to display default value in this case.
190                     if ($caller->isSubmitted()) {
191                         $value = $this->_findValue($caller->_submitValues);
192                     } else {
193                         $value = $this->_findValue($caller->_defaultValues);
194                     }
195                 }
196                 $requestvalue=$value;
197                 if ($value == 0) {
198                     $value = $this->_options['defaulttime'];
199                     if (!$value) {
200                         $value = time();
201                     }
202                 }
203                 if (!is_array($value)) {
204                     $calendartype = \core_calendar\type_factory::get_calendar_instance();
205                     $currentdate = $calendartype->timestamp_to_date_array($value, $this->_options['timezone']);
206                     // Round minutes to the previous multiple of step.
207                     $currentdate['minutes'] -= $currentdate['minutes'] % $this->_options['step'];
208                     $value = array(
209                         'minute' => $currentdate['minutes'],
210                         'hour' => $currentdate['hours'],
211                         'day' => $currentdate['mday'],
212                         'month' => $currentdate['mon'],
213                         'year' => $currentdate['year']);
214                     // If optional, default to off, unless a date was provided.
215                     if ($this->_options['optional']) {
216                         $value['enabled'] = $requestvalue != 0;
217                     }
218                 } else {
219                     $value['enabled'] = isset($value['enabled']);
220                 }
221                 if (null !== $value) {
222                     $this->setValue($value);
223                 }
224                 break;
225             case 'createElement':
226                 if (isset($arg[2]['optional']) && $arg[2]['optional']) {
227                     // When using the function addElement, rather than createElement, we still
228                     // enter this case, making this check necessary.
229                     if ($this->_usedcreateelement) {
230                         $caller->disabledIf($arg[0] . '[day]', $arg[0] . '[enabled]');
231                         $caller->disabledIf($arg[0] . '[month]', $arg[0] . '[enabled]');
232                         $caller->disabledIf($arg[0] . '[year]', $arg[0] . '[enabled]');
233                         $caller->disabledIf($arg[0] . '[hour]', $arg[0] . '[enabled]');
234                         $caller->disabledIf($arg[0] . '[minute]', $arg[0] . '[enabled]');
235                     } else {
236                         $caller->disabledIf($arg[0], $arg[0] . '[enabled]');
237                     }
238                 }
239                 return parent::onQuickFormEvent($event, $arg, $caller);
240                 break;
241             case 'addElement':
242                 $this->_usedcreateelement = false;
243                 return parent::onQuickFormEvent($event, $arg, $caller);
244                 break;
245             default:
246                 return parent::onQuickFormEvent($event, $arg, $caller);
247         }
248     }
250     /**
251      * Returns HTML for advchecbox form element.
252      *
253      * @return string
254      */
255     function toHtml() {
256         include_once('HTML/QuickForm/Renderer/Default.php');
257         $renderer = new HTML_QuickForm_Renderer_Default();
258         $renderer->setElementTemplate('{element}');
259         parent::accept($renderer);
261         $html = $this->_wrap[0];
262         if ($this->_usedcreateelement) {
263             $html .= html_writer::tag('span', $renderer->toHtml(), array('class' => 'fdate_time_selector'));
264         } else {
265             $html .= $renderer->toHtml();
266         }
267         $html .= $this->_wrap[1];
269         return $html;
270     }
272     /**
273      * Accepts a renderer
274      *
275      * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
276      * @param bool $required Whether a group is required
277      * @param string $error An error message associated with a group
278      */
279     function accept(&$renderer, $required = false, $error = null) {
280         form_init_date_js();
281         $renderer->renderElement($this, $required, $error);
282     }
284     /**
285      * Export for template
286      *
287      * @param renderer_base $output
288      * @return array|stdClass
289      */
290     public function export_for_template(renderer_base $output) {
291         form_init_date_js();
292         return parent::export_for_template($output);
293     }
295     /**
296      * Output a timestamp. Give it the name of the group.
297      *
298      * @param array $submitValues values submitted.
299      * @param bool $assoc specifies if returned array is associative
300      * @return array
301      */
302     function exportValue(&$submitValues, $assoc = false) {
303         $valuearray = array();
304         foreach ($this->_elements as $element){
305             $thisexport = $element->exportValue($submitValues[$this->getName()], true);
306             if ($thisexport!=null){
307                 $valuearray += $thisexport;
308             }
309         }
310         if (count($valuearray)){
311             if($this->_options['optional']) {
312                 // If checkbox is on, the value is zero, so go no further
313                 if(empty($valuearray['enabled'])) {
314                     return $this->_prepareValue(0, $assoc);
315                 }
316             }
317             // Get the calendar type used - see MDL-18375.
318             $calendartype = \core_calendar\type_factory::get_calendar_instance();
319             $gregoriandate = $calendartype->convert_to_gregorian($valuearray['year'],
320                                                                  $valuearray['month'],
321                                                                  $valuearray['day'],
322                                                                  $valuearray['hour'],
323                                                                  $valuearray['minute']);
324             $value = make_timestamp($gregoriandate['year'],
325                                                       $gregoriandate['month'],
326                                                       $gregoriandate['day'],
327                                                       $gregoriandate['hour'],
328                                                       $gregoriandate['minute'],
329                                                       0,
330                                                       $this->_options['timezone'],
331                                                       true);
333             return $this->_prepareValue($value, $assoc);
334         } else {
335             return null;
336         }
337     }