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