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