MDL-27562 formslib: applydst should be always true, hence option removed from datesel...
[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     /** @var array These complement separators, they are appended to the resultant HTML */
60     var $_wrap = array('', '');
62     /**
63      * Class constructor
64      *
65      * @param string $elementName Element's name
66      * @param mixed $elementLabel Label(s) for an element
67      * @param array $options Options to control the element's display
68      * @param mixed $attributes Either a typical HTML attribute string or an associative array
69      */
70     function MoodleQuickForm_date_time_selector($elementName = null, $elementLabel = null, $options = array(), $attributes = null)
71     {
72         $this->HTML_QuickForm_element($elementName, $elementLabel, $attributes);
73         $this->_persistantFreeze = true;
74         $this->_appendName = true;
75         $this->_type = 'date_time_selector';
76         // set the options, do not bother setting bogus ones
77         if (is_array($options)) {
78             foreach ($options as $name => $value) {
79                 if (isset($this->_options[$name])) {
80                     if (is_array($value) && is_array($this->_options[$name])) {
81                         $this->_options[$name] = @array_merge($this->_options[$name], $value);
82                     } else {
83                         $this->_options[$name] = $value;
84                     }
85                 }
86             }
87         }
88         form_init_date_js();
89     }
91     /**
92      * This will create date group element constisting of day, month and year.
93      *
94      * @access private
95      */
96     function _createElements()
97     {
98         $this->_elements = array();
99         for ($i=1; $i<=31; $i++) {
100             $days[$i] = $i;
101         }
102         for ($i=1; $i<=12; $i++) {
103             $months[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B");
104         }
105         for ($i=$this->_options['startyear']; $i<=$this->_options['stopyear']; $i++) {
106             $years[$i] = $i;
107         }
108         for ($i=0; $i<=23; $i++) {
109             $hours[$i] = sprintf("%02d",$i);
110         }
111         for ($i=0; $i<60; $i+=$this->_options['step']) {
112             $minutes[$i] = sprintf("%02d",$i);
113         }
114         // E_STRICT creating elements without forms is nasty because it internally uses $this
115         $this->_elements[] = @MoodleQuickForm::createElement('select', 'day', get_string('day', 'form'), $days, $this->getAttributes(), true);
116         $this->_elements[] = @MoodleQuickForm::createElement('select', 'month', get_string('month', 'form'), $months, $this->getAttributes(), true);
117         $this->_elements[] = @MoodleQuickForm::createElement('select', 'year', get_string('year', 'form'), $years, $this->getAttributes(), true);
118         if (right_to_left()) {   // Switch order of elements for Right-to-Left
119             $this->_elements[] = @MoodleQuickForm::createElement('select', 'minute', get_string('minute', 'form'), $minutes, $this->getAttributes(), true);
120             $this->_elements[] = @MoodleQuickForm::createElement('select', 'hour', get_string('hour', 'form'), $hours, $this->getAttributes(), true);
121         } else {
122             $this->_elements[] = @MoodleQuickForm::createElement('select', 'hour', get_string('hour', 'form'), $hours, $this->getAttributes(), true);
123             $this->_elements[] = @MoodleQuickForm::createElement('select', 'minute', get_string('minute', 'form'), $minutes, $this->getAttributes(), true);
124         }
125         // If optional we add a checkbox which the user can use to turn if on
126         if($this->_options['optional']) {
127             $this->_elements[] = @MoodleQuickForm::createElement('checkbox', 'enabled', null, get_string('enable'), $this->getAttributes(), true);
128         }
129         foreach ($this->_elements as $element){
130             if (method_exists($element, 'setHiddenLabel')){
131                 $element->setHiddenLabel(true);
132             }
133         }
135     }
137     /**
138      * Called by HTML_QuickForm whenever form event is made on this element
139      *
140      * @param string $event Name of event
141      * @param mixed $arg event arguments
142      * @param object $caller calling object
143      * @return bool
144      */
145     function onQuickFormEvent($event, $arg, &$caller)
146     {
147         switch ($event) {
148             case 'updateValue':
149                 // constant values override both default and submitted ones
150                 // default values are overriden by submitted
151                 $value = $this->_findValue($caller->_constantValues);
152                 if (null === $value) {
153                     // if no boxes were checked, then there is no value in the array
154                     // yet we don't want to display default value in this case
155                     if ($caller->isSubmitted()) {
156                         $value = $this->_findValue($caller->_submitValues);
157                     } else {
158                         $value = $this->_findValue($caller->_defaultValues);
159                     }
160                 }
161                 $requestvalue=$value;
162                 if ($value == 0) {
163                     $value = $this->_options['defaulttime'];
164                     if (!$value) {
165                         $value = time();
166                     }
167                 }
168                 if (!is_array($value)) {
169                     $currentdate = usergetdate($value, $this->_options['timezone']);
170                     // Round minutes to the previous multiple of step.
171                     $currentdate['minutes'] -= $currentdate['minutes'] % $this->_options['step'];
172                     $value = array(
173                         'minute' => $currentdate['minutes'],
174                         'hour' => $currentdate['hours'],
175                         'day' => $currentdate['mday'],
176                         'month' => $currentdate['mon'],
177                         'year' => $currentdate['year']);
178                     // If optional, default to off, unless a date was provided
179                     if($this->_options['optional']) {
180                         $value['enabled'] = $requestvalue != 0;
181                     }
182                 } else {
183                     $value['enabled'] = isset($value['enabled']);
184                 }
185                 if (null !== $value){
186                     $this->setValue($value);
187                 }
188                 break;
189             case 'createElement':
190                 if($arg[2]['optional']) {
191                     $caller->disabledIf($arg[0], $arg[0].'[enabled]');
192                 }
193                 return parent::onQuickFormEvent($event, $arg, $caller);
194                 break;
195             default:
196                 return parent::onQuickFormEvent($event, $arg, $caller);
197         }
198     }
200     /**
201      * Returns HTML for advchecbox form element.
202      *
203      * @return string
204      */
205     function toHtml()
206     {
207         include_once('HTML/QuickForm/Renderer/Default.php');
208         $renderer = new HTML_QuickForm_Renderer_Default();
209         $renderer->setElementTemplate('{element}');
210         parent::accept($renderer);
211         return $this->_wrap[0] . $renderer->toHtml() . $this->_wrap[1];
212     }
214     /**
215      * Accepts a renderer
216      *
217      * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
218      * @param bool $required Whether a group is required
219      * @param string $error An error message associated with a group
220      */
221     function accept(&$renderer, $required = false, $error = null)
222     {
223         $renderer->renderElement($this, $required, $error);
224     }
226     /**
227      * Output a timestamp. Give it the name of the group.
228      *
229      * @param array $submitValues values submitted.
230      * @param bool $assoc specifies if returned array is associative
231      * @return array
232      */
233     function exportValue(&$submitValues, $assoc = false)
234     {
235         $value = null;
236         $valuearray = array();
237         foreach ($this->_elements as $element){
238             $thisexport = $element->exportValue($submitValues[$this->getName()], true);
239             if ($thisexport!=null){
240                 $valuearray += $thisexport;
241             }
242         }
243         if (count($valuearray)){
244             if($this->_options['optional']) {
245                 // If checkbox is on, the value is zero, so go no further
246                 if(empty($valuearray['enabled'])) {
247                     $value[$this->getName()] = 0;
248                     return $value;
249                 }
250             }
251             $valuearray=$valuearray + array('year' => 1970, 'month' => 1, 'day' => 1, 'hour' => 0, 'minute' => 0);
252             $value[$this->getName()] = make_timestamp(
253                                    $valuearray['year'],
254                                    $valuearray['month'],
255                                    $valuearray['day'],
256                                    $valuearray['hour'],
257                                    $valuearray['minute'],
258                                    0,
259                                    $this->_options['timezone'],
260                                    true);
262             return $value;
263         } else {
265             return null;
266         }
267     }