ab8929af738a0d49cc45724d14286df819c032ed
[moodle.git] / lib / form / defaultcustom.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  * Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector)
20  *
21  * @package   core_form
22  * @copyright 2017 Marina Glancy
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 global $CFG;
27 require_once($CFG->libdir . '/form/group.php');
28 require_once($CFG->libdir . '/formslib.php');
30 /**
31  * Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector)
32  *
33  * @package   core_form
34  * @copyright 2017 Marina Glancy
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class MoodleQuickForm_defaultcustom extends MoodleQuickForm_group {
39     /**
40      * @var array These complement separators, they are appended to the resultant HTML.
41      */
42     protected $_wrap = array('', '');
44     /**
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.
48      */
49     protected $_usedcreateelement = true;
51     /** @var array */
52     protected $_options;
54     /**
55      * Constructor
56      *
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
61      */
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();
70         $this->_options = [
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.
76             'timezone' => 99,
77             'startyear' => $calendartype->get_min_year(),
78             'stopyear' => $calendartype->get_max_year(),
79             'defaulttime' => 0,
80             'step' => 1,
81             'optional' => false,
82         ];
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'])) {
88                         throw new coding_exception('Only text and date_selector elements are supported in ' . $this->_type);
89                     }
90                     if ($name === 'optional' && $value) {
91                         throw new coding_exception('Date selector can not be optional in ' . $this->_type);
92                     }
93                     $this->_options[$name] = $value;
94                 }
95             }
96         }
97     }
99     /**
100      * Converts timestamp to the day/month/year array in the current calendar format
101      * @param int $value
102      * @return array
103      */
104     protected function timestamp_to_date_array($value) {
105         $calendartype = \core_calendar\type_factory::get_calendar_instance();
106         $currentdate = $calendartype->timestamp_to_date_array($value, $this->_options['timezone']);
107         return array(
108             'day' => $currentdate['mday'],
109             'month' => $currentdate['mon'],
110             'year' => $currentdate['year']);
111     }
113     /**
114      * Should this element have default/custom switch?
115      *
116      * @return bool
117      */
118     protected function has_customize_switch() {
119         return $this->_options['defaultvalue'] !== null;
120     }
122     /**
123      * This will create all elements in the group
124      */
125     public function _createElements() {
126         if (!$this->has_customize_switch()) {
127             $element = $this->createFormElement('hidden', 'customize', 1);
128         } else {
129             $element = $this->createFormElement('advcheckbox', 'customize', '', $this->_options['customlabel']);
130         }
131         $this->_elements[] = $element;
133         if ($this->_options['type'] === 'text') {
134             $element = $this->createFormElement($this->_options['type'], 'value',
135                 get_string('newvaluefor', 'form', $this->getLabel()), $this->getAttributes());
136             $element->setHiddenLabel(true);
137         } else if ($this->_options['type'] === 'date_selector') {
138             $element = $this->createFormElement($this->_options['type'], 'value', '', $this->_options,
139                 $this->getAttributes());
140         }
141         $this->_elements[] = $element;
142     }
144     /**
145      * Called by HTML_QuickForm whenever form event is made on this element
146      *
147      * @param string $event Name of event
148      * @param mixed $arg event arguments
149      * @param object $caller calling object
150      * @return bool
151      */
152     public function onQuickFormEvent($event, $arg, &$caller) {
153         $this->setMoodleForm($caller);
154         switch ($event) {
155             case 'updateValue':
156                 // Constant values override both default and submitted ones
157                 // default values are overriden by submitted.
158                 $value = $this->_findValue($caller->_constantValues);
159                 if (null === $value) {
160                     // If no boxes were checked, then there is no value in the array
161                     // yet we don't want to display default value in this case.
162                     if ($caller->isSubmitted()) {
163                         $value = $this->_findValue($caller->_submitValues);
164                     } else {
165                         $value = $this->_findValue($caller->_defaultValues);
166                     }
167                 }
168                 if (!is_array($value)) {
169                     $customize = ($value !== false || !$this->has_customize_switch());
170                     if ($this->_options['type'] === 'text') {
171                         $elementvalue = $customize ? $value : $this->_options['defaultvalue'];
172                     } else {
173                         $elementvalue = $this->timestamp_to_date_array($customize ? $value : $this->_options['defaultvalue']);
174                     }
175                     $value = [
176                         'customize' => $customize,
177                         'value' => $elementvalue
178                     ];
179                 }
180                 $this->setValue($value);
181                 break;
182             case 'createElement':
183                 $rv = parent::onQuickFormEvent($event, $arg, $caller);
184                 if ($this->has_customize_switch()) {
185                     if ($this->_options['type'] === 'text') {
186                         $caller->disabledIf($arg[0] . '[value]', $arg[0] . '[customize]', 'notchecked');
187                     } else {
188                         $caller->disabledIf($arg[0] . '[value][day]', $arg[0] . '[customize]', 'notchecked');
189                         $caller->disabledIf($arg[0] . '[value][month]', $arg[0] . '[customize]', 'notchecked');
190                         $caller->disabledIf($arg[0] . '[value][year]', $arg[0] . '[customize]', 'notchecked');
191                     }
192                 }
193                 return $rv;
194             case 'addElement':
195                 $this->_usedcreateelement = false;
196                 return parent::onQuickFormEvent($event, $arg, $caller);
197                 break;
198             default:
199                 return parent::onQuickFormEvent($event, $arg, $caller);
200         }
201     }
203     public function freeze() {
204         parent::freeze();
205         $this->setPersistantFreeze(true);
206     }
208     public function toHtml() {
209         include_once('HTML/QuickForm/Renderer/Default.php');
210         $renderer = new HTML_QuickForm_Renderer_Default();
211         $renderer->setElementTemplate('{element}');
212         parent::accept($renderer);
214         $html = $this->_wrap[0];
215         if ($this->_usedcreateelement) {
216             $html .= html_writer::tag('span', $renderer->toHtml(), array('class' => 'fdefaultcustom'));
217         } else {
218             $html .= $renderer->toHtml();
219         }
220         $html .= $this->_wrap[1];
222         return $html;
223     }
225     public function accept(&$renderer, $required = false, $error = null) {
226         global $PAGE;
228         if (!$this->_flagFrozen && $this->has_customize_switch()) {
229             // Add JS to the default/custom switch.
230             $firstelement = reset($this->_elements);
231             $defaultvalue = $this->_options['defaultvalue'];
232             $customvalue = $this->_options['customvalue'];
233             if ($this->_options['type'] === 'date_selector') {
234                 $defaultvalue = $this->timestamp_to_date_array($defaultvalue);
235                 $customvalue = $this->timestamp_to_date_array($customvalue);
236             }
237             $firstelement->updateAttributes(['data-defaultcustom' => 'true',
238                 'data-type' => $this->_options['type'],
239                 'data-defaultvalue' => json_encode($defaultvalue),
240                 'data-customvalue' => json_encode($customvalue)]);
241             $PAGE->requires->js_amd_inline("require(['core_form/defaultcustom'], function() {});");
242         }
244         $renderer->renderElement($this, $required, $error);
245     }
247     /**
248      * Output a value. Give it the name of the group. In case of "default" return false.
249      *
250      * @param array $submitvalues values submitted.
251      * @param bool $assoc specifies if returned array is associative
252      * @return array
253      */
254     public function exportValue(&$submitvalues, $assoc = false) {
255         $valuearray = array();
256         foreach ($this->_elements as $element) {
257             $thisexport = $element->exportValue($submitvalues[$this->getName()], true);
258             if ($thisexport != null) {
259                 $valuearray += $thisexport;
260             }
261         }
262         if (empty($valuearray['customize'])) {
263             return $this->_prepareValue(false, $assoc);
264         }
265         return array_key_exists('value', $valuearray) ? $this->_prepareValue($valuearray['value'], $assoc) : [];
266     }