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 * Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector)
22 * @copyright 2017 Marina Glancy
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 require_once($CFG->libdir
. '/form/group.php');
28 require_once($CFG->libdir
. '/formslib.php');
31 * Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector)
34 * @copyright 2017 Marina Glancy
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 class MoodleQuickForm_defaultcustom
extends MoodleQuickForm_group
{
40 * @var array These complement separators, they are appended to the resultant HTML.
42 protected $_wrap = array('', '');
45 * @var null|bool Keeps track of whether the date selector was initialised using createElement
46 * or addElement. If true, createElement was used signifying the element has been
47 * added to a group - see MDL-39187.
49 protected $_usedcreateelement = true;
57 * @param string $elementname Element's name
58 * @param mixed $elementlabel Label(s) for an element
59 * @param array $options Options to control the element's display
60 * @param mixed $attributes Either a typical HTML attribute string or an associative array
62 public function __construct($elementname = null, $elementlabel = null, $options = array(), $attributes = null) {
63 parent
::__construct($elementname, $elementlabel);
64 $this->setAttributes($attributes);
66 $this->_appendName
= true;
67 $this->_type
= 'defaultcustom';
69 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
71 'type' => 'text', // Type of the element. Supported are 'text' and 'date_selector'.
72 'defaultvalue' => null, // Value to be used when not overridden.
73 'customvalue' => null, // Value to be used when overwriting.
74 'customlabel' => get_string('custom', 'form'), // Label for 'customize' checkbox
75 // Other options are the same as the ones that can be passed to 'date_selector' element.
77 'startyear' => $calendartype->get_min_year(),
78 'stopyear' => $calendartype->get_max_year(),
84 if (is_array($options)) {
85 foreach ($options as $name => $value) {
86 if (array_key_exists($name, $this->_options
)) {
87 if ($name === 'type' && !in_array($value, ['text', 'date_selector', 'date_time_selector'])) {
88 throw new coding_exception('Only text, date_selector, and date_time_selector elements are supported in ' . $this->_type
);
90 if ($name === 'optional' && $value) {
91 throw new coding_exception('Date selector can not be optional in ' . $this->_type
);
93 $this->_options
[$name] = $value;
100 * Converts timestamp to the day/month/year array in the current calendar format
104 protected function timestamp_to_date_array($value) {
105 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
106 $currentdate = $calendartype->timestamp_to_date_array((int)$value, $this->_options
['timezone']);
108 'minute' => $currentdate['minutes'],
109 'hour' => $currentdate['hours'],
110 'day' => $currentdate['mday'],
111 'month' => $currentdate['mon'],
112 'year' => $currentdate['year']);
116 * Should this element have default/custom switch?
120 protected function has_customize_switch() {
121 return $this->_options
['defaultvalue'] !== null;
125 * This will create all elements in the group
127 public function _createElements() {
128 if (!$this->has_customize_switch()) {
129 $element = $this->createFormElement('hidden', 'customize', 1);
131 $element = $this->createFormElement('advcheckbox', 'customize', '', $this->_options
['customlabel']);
133 $this->_elements
[] = $element;
135 if ($this->_options
['type'] === 'text') {
136 $element = $this->createFormElement($this->_options
['type'], 'value',
137 get_string('newvaluefor', 'form', $this->getLabel()), $this->getAttributes());
138 $element->setHiddenLabel(true);
139 } else if ($this->_options
['type'] === 'date_selector') {
140 $element = $this->createFormElement($this->_options
['type'], 'value', '', $this->_options
,
141 $this->getAttributes());
142 } else if ($this->_options
['type'] === 'date_time_selector') {
143 $element = $this->createFormElement($this->_options
['type'], 'value', '', $this->_options
,
144 $this->getAttributes());
146 $this->_elements
[] = $element;
150 * Called by HTML_QuickForm whenever form event is made on this element
152 * @param string $event Name of event
153 * @param mixed $arg event arguments
154 * @param object $caller calling object
157 public function onQuickFormEvent($event, $arg, &$caller) {
158 $this->setMoodleForm($caller);
161 // Constant values override both default and submitted ones
162 // default values are overriden by submitted.
163 $value = $this->_findValue($caller->_constantValues
);
164 if (null === $value) {
165 // If no boxes were checked, then there is no value in the array
166 // yet we don't want to display default value in this case.
167 if ($caller->isSubmitted()) {
168 $value = $this->_findValue($caller->_submitValues
);
170 $value = $this->_findValue($caller->_defaultValues
);
173 if (!is_array($value)) {
174 $customize = ($value !== false ||
!$this->has_customize_switch());
175 if ($this->_options
['type'] === 'text') {
176 $elementvalue = $customize ?
$value : $this->_options
['defaultvalue'];
178 $elementvalue = $this->timestamp_to_date_array($customize ?
$value : $this->_options
['defaultvalue']);
181 'customize' => $customize,
182 'value' => $elementvalue
185 $this->setValue($value);
187 case 'createElement':
188 $rv = parent
::onQuickFormEvent($event, $arg, $caller);
189 if ($this->has_customize_switch()) {
190 if ($this->_options
['type'] === 'text') {
191 $caller->disabledIf($arg[0] . '[value]', $arg[0] . '[customize]', 'notchecked');
192 } else if ($this->_options
['type'] === 'date_selector') {
193 $caller->disabledIf($arg[0] . '[value][day]', $arg[0] . '[customize]', 'notchecked');
194 $caller->disabledIf($arg[0] . '[value][month]', $arg[0] . '[customize]', 'notchecked');
195 $caller->disabledIf($arg[0] . '[value][year]', $arg[0] . '[customize]', 'notchecked');
197 // Date / Time selector.
198 $caller->disabledIf($arg[0] . '[value][day]', $arg[0] . '[customize]', 'notchecked');
199 $caller->disabledIf($arg[0] . '[value][month]', $arg[0] . '[customize]', 'notchecked');
200 $caller->disabledIf($arg[0] . '[value][year]', $arg[0] . '[customize]', 'notchecked');
201 $caller->disabledIf($arg[0] . '[value][hour]', $arg[0] . '[customize]', 'notchecked');
202 $caller->disabledIf($arg[0] . '[value][minute]', $arg[0] . '[customize]', 'notchecked');
207 $this->_usedcreateelement
= false;
208 return parent
::onQuickFormEvent($event, $arg, $caller);
211 return parent
::onQuickFormEvent($event, $arg, $caller);
215 public function freeze() {
217 $this->setPersistantFreeze(true);
220 public function toHtml() {
221 include_once('HTML/QuickForm/Renderer/Default.php');
222 $renderer = new HTML_QuickForm_Renderer_Default();
223 $renderer->setElementTemplate('{element}');
224 parent
::accept($renderer);
226 $html = $this->_wrap
[0];
227 if ($this->_usedcreateelement
) {
228 $html .= html_writer
::tag('span', $renderer->toHtml(), array('class' => 'fdefaultcustom'));
230 $html .= $renderer->toHtml();
232 $html .= $this->_wrap
[1];
237 public function accept(&$renderer, $required = false, $error = null) {
240 if (!$this->_flagFrozen
&& $this->has_customize_switch()) {
241 // Add JS to the default/custom switch.
242 $firstelement = reset($this->_elements
);
243 $defaultvalue = $this->_options
['defaultvalue'];
244 $customvalue = $this->_options
['customvalue'];
245 if ($this->_options
['type'] === 'date_selector' ||
$this->_options
['type'] === 'date_time_selector') {
246 $defaultvalue = $this->timestamp_to_date_array($defaultvalue);
247 $customvalue = $this->timestamp_to_date_array($customvalue);
249 $firstelement->updateAttributes(['data-defaultcustom' => 'true',
250 'data-type' => $this->_options
['type'],
251 'data-defaultvalue' => json_encode($defaultvalue),
252 'data-customvalue' => json_encode($customvalue)]);
253 $PAGE->requires
->js_amd_inline("require(['core_form/defaultcustom'], function() {});");
256 $renderer->renderElement($this, $required, $error);
260 * Output a value. Give it the name of the group. In case of "default" return false.
262 * @param array $submitvalues values submitted.
263 * @param bool $assoc specifies if returned array is associative
266 public function exportValue(&$submitvalues, $assoc = false) {
267 $valuearray = array();
268 foreach ($this->_elements
as $element) {
269 $thisexport = $element->exportValue($submitvalues[$this->getName()], true);
270 if ($thisexport != null) {
271 $valuearray +
= $thisexport;
274 if (empty($valuearray['customize'])) {
275 return $this->_prepareValue(false, $assoc);
277 return array_key_exists('value', $valuearray) ?
$this->_prepareValue($valuearray['value'], $assoc) : [];