2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Group of date input element
21 * Contains class for a group of elements used to input a date.
24 * @copyright 2007 Jamie Pratt <me@jamiep.org>
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 require_once($CFG->libdir
. '/form/group.php');
30 require_once($CFG->libdir
. '/formslib.php');
33 * Class for a group of elements used to input a date.
35 * Emulates moodle print_date_selector function
39 * @copyright 2007 Jamie Pratt <me@jamiep.org>
40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 class MoodleQuickForm_date_selector
extends MoodleQuickForm_group
{
45 * Control the fieldnames for form elements.
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 https://moodledev.io/docs/apis/subsystems/time#timezone}
53 * optional => if true, show a checkbox beside the date to turn it on (or off)
56 protected $_options = array();
59 * @var array These complement separators, they are appended to the resultant HTML.
61 protected $_wrap = array('', '');
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.
68 protected $_usedcreateelement = true;
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
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' => 1, '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);
95 $this->_options
[$name] = $value;
103 * Old syntax of class constructor. Deprecated in PHP7.
105 * @deprecated since Moodle 3.1
107 public function MoodleQuickForm_date_selector($elementName = null, $elementLabel = null, $options = array(), $attributes = null) {
108 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER
);
109 self
::__construct($elementName, $elementLabel, $options, $attributes);
113 * This will create date group element constisting of day, month and year.
117 function _createElements() {
120 // Get the calendar type used - see MDL-18375.
121 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
123 $this->_elements
= array();
125 $dateformat = $calendartype->get_date_order($this->_options
['startyear'], $this->_options
['stopyear']);
126 // Reverse date element (Day, Month, Year), in RTL mode.
127 if (right_to_left()) {
128 $dateformat = array_reverse($dateformat);
130 // If optional we add a checkbox which the user can use to turn if on.
131 if ($this->_options
['optional']) {
132 $this->_elements
[] = $this->createFormElement('checkbox', 'enabled', null,
133 get_string('enable'), $this->getAttributesForFormElement(), true);
135 foreach ($dateformat as $key => $value) {
136 // E_STRICT creating elements without forms is nasty because it internally uses $this
137 $this->_elements
[] = $this->createFormElement('select', $key, get_string($key, 'form'), $value,
138 $this->getAttributesForFormElement(), true);
140 // The YUI2 calendar only supports the gregorian calendar type so only display the calendar image if this is being used.
141 if ($calendartype->get_name() === 'gregorian') {
142 $image = $OUTPUT->pix_icon('i/calendar', get_string('calendar', 'calendar'), 'moodle');
143 $this->_elements
[] = $this->createFormElement('link', 'calendar',
146 foreach ($this->_elements
as $element){
147 if (method_exists($element, 'setHiddenLabel')){
148 $element->setHiddenLabel(true);
155 * Called by HTML_QuickForm whenever form event is made on this element
157 * @param string $event Name of event
158 * @param mixed $arg event arguments
159 * @param object $caller calling object
162 function onQuickFormEvent($event, $arg, &$caller) {
163 $this->setMoodleForm($caller);
166 // Constant values override both default and submitted ones
167 // default values are overriden by submitted.
168 $value = $this->_findValue($caller->_constantValues
);
169 if (null === $value) {
170 // If no boxes were checked, then there is no value in the array
171 // yet we don't want to display default value in this case.
172 if ($caller->isSubmitted() && !$caller->is_new_repeat($this->getName())) {
173 $value = $this->_findValue($caller->_submitValues
);
175 $value = $this->_findValue($caller->_defaultValues
);
178 $requestvalue=$value;
182 if (!is_array($value)) {
183 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
184 $currentdate = $calendartype->timestamp_to_date_array($value, $this->_options
['timezone']);
186 'day' => $currentdate['mday'],
187 'month' => $currentdate['mon'],
188 'year' => $currentdate['year']);
189 // If optional, default to off, unless a date was provided.
190 if ($this->_options
['optional']) {
191 $value['enabled'] = $requestvalue != 0;
194 $value['enabled'] = isset($value['enabled']);
196 if (null !== $value) {
197 $this->setValue($value);
200 case 'createElement':
201 // Optional is an optional param, if its set we need to add a disabledIf rule.
202 // If its empty or not specified then its not an optional dateselector.
203 if (!empty($arg[2]['optional']) && !empty($arg[0])) {
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]');
211 $caller->disabledIf($arg[0], $arg[0] . '[enabled]');
214 return parent
::onQuickFormEvent($event, $arg, $caller);
217 $this->_usedcreateelement
= false;
218 return parent
::onQuickFormEvent($event, $arg, $caller);
221 return parent
::onQuickFormEvent($event, $arg, $caller);
226 * Returns HTML for advchecbox form element.
231 include_once('HTML/QuickForm/Renderer/Default.php');
232 $renderer = new HTML_QuickForm_Renderer_Default();
233 $renderer->setElementTemplate('{element}');
234 parent
::accept($renderer);
236 $html = $this->_wrap
[0];
237 if ($this->_usedcreateelement
) {
238 $html .= html_writer
::tag('span', $renderer->toHtml(), array('class' => 'fdate_selector'));
240 $html .= $renderer->toHtml();
242 $html .= $this->_wrap
[1];
250 * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
251 * @param bool $required Whether a group is required
252 * @param string $error An error message associated with a group
254 function accept(&$renderer, $required = false, $error = null) {
256 $renderer->renderElement($this, $required, $error);
260 * Export for template
262 * @param renderer_base $output
263 * @return array|stdClass
265 public function export_for_template(renderer_base
$output) {
267 return parent
::export_for_template($output);
271 * Output a timestamp. Give it the name of the group.
273 * @param array $submitValues values submitted.
274 * @param bool $assoc specifies if returned array is associative
277 function exportValue(&$submitValues, $assoc = false) {
278 $valuearray = array();
279 foreach ($this->_elements
as $element){
280 $thisexport = $element->exportValue($submitValues[$this->getName()], true);
281 if ($thisexport!=null){
282 $valuearray +
= $thisexport;
285 if (count($valuearray) && isset($valuearray['year'])) {
286 if($this->_options
['optional']) {
287 // If checkbox is on, the value is zero, so go no further
288 if(empty($valuearray['enabled'])) {
289 return $this->_prepareValue(0, $assoc);
292 // Get the calendar type used - see MDL-18375.
293 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
294 $gregoriandate = $calendartype->convert_to_gregorian($valuearray['year'], $valuearray['month'], $valuearray['day']);
295 $value = make_timestamp($gregoriandate['year'],
296 $gregoriandate['month'],
297 $gregoriandate['day'],
299 $this->_options
['timezone'],
302 return $this->_prepareValue($value, $assoc);