MDL-56577 core_form: Let other option attrs to be set in select elements
[moodle.git] / lib / form / selectgroups.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  * select type form element
20  *
21  * Class to dynamically create an HTML SELECT with all options grouped in optgroups
22  *
23  * @package   core_form
24  * @copyright 2007 Jamie Pratt <me@jamiep.org>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 require_once('HTML/QuickForm/element.php');
29 require_once('templatable_form_element.php');
31 /**
32  * select type form element
33  *
34  * Class to dynamically create an HTML SELECT with all options grouped in optgroups
35  *
36  * @package   core_form
37  * @category  form
38  * @copyright 2007 Jamie Pratt <me@jamiep.org>
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class MoodleQuickForm_selectgroups extends HTML_QuickForm_element implements templatable {
43     use templatable_form_element {
44         export_for_template as export_for_template_base;
45     }
47     /** @var bool add choose option */
48     var $showchoose = false;
50     /** @var array Contains the select optgroups */
51     var $_optGroups = array();
53     /** @var string Default values of the SELECT */
54     var $_values = null;
56     /** @var string html for help button, if empty then no help */
57     var $_helpbutton='';
59     /** @var bool if true label will be hidden */
60     var $_hiddenLabel=false;
62     /**
63      * Class constructor
64      *
65      * @param string $elementName Select name attribute
66      * @param mixed $elementLabel Label(s) for the select
67      * @param array $optgrps Data to be used to populate options
68      * @param mixed $attributes Either a typical HTML attribute string or an associative array
69      * @param bool $showchoose add standard moodle "Choose..." option as first item
70      */
71     public function __construct($elementName=null, $elementLabel=null, $optgrps=null, $attributes=null, $showchoose=false)
72     {
73         $this->showchoose = $showchoose;
74         parent::__construct($elementName, $elementLabel, $attributes);
75         $this->_persistantFreeze = true;
76         $this->_type = 'selectgroups';
77         if (isset($optgrps)) {
78             $this->loadArrayOptGroups($optgrps);
79         }
80     }
82     /**
83      * Old syntax of class constructor. Deprecated in PHP7.
84      *
85      * @deprecated since Moodle 3.1
86      */
87     public function MoodleQuickForm_selectgroups($elementName=null, $elementLabel=null, $optgrps=null, $attributes=null, $showchoose=false) {
88         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
89         self::__construct($elementName, $elementLabel, $optgrps, $attributes, $showchoose);
90     }
92     /**
93      * Sets the default values of the select box
94      *
95      * @param mixed $values Array or comma delimited string of selected values
96      */
97     function setSelected($values)
98     {
99         if (is_string($values) && $this->getMultiple()) {
100             $values = preg_split("/[ ]?,[ ]?/", $values);
101         }
102         if (is_array($values)) {
103             $this->_values = array_values($values);
104         } else {
105             $this->_values = array($values);
106         }
107     }
109     /**
110      * Returns an array of the selected values
111      *
112      * @return array of selected values
113      */
114     function getSelected()
115     {
116         return $this->_values;
117     }
119     /**
120      * Sets the input field name
121      *
122      * @param string $name Input field name attribute
123      */
124     function setName($name)
125     {
126         $this->updateAttributes(array('name' => $name));
127     }
129     /**
130      * Returns the element name
131      *
132      * @return string
133      */
134     function getName()
135     {
136         return $this->getAttribute('name');
137     }
139     /**
140      * Returns the element name (possibly with brackets appended)
141      *
142      * @return string
143      */
144     function getPrivateName()
145     {
146         if ($this->getAttribute('multiple')) {
147             return $this->getName() . '[]';
148         } else {
149             return $this->getName();
150         }
151     }
153     /**
154      * Sets the value of the form element
155      *
156      * @param mixed $value Array or comma delimited string of selected values
157      */
158     function setValue($value)
159     {
160         $this->setSelected($value);
161     }
163     /**
164      * Returns an array of the selected values
165      *
166      * @return array of selected values
167      */
168     function getValue()
169     {
170         return $this->_values;
171     }
173     /**
174      * Sets the select field size, only applies to 'multiple' selects
175      *
176      * @param int $size Size of select  field
177      */
178     function setSize($size)
179     {
180         $this->updateAttributes(array('size' => $size));
181     }
183     /**
184      * Returns the select field size
185      *
186      * @return int
187      */
188     function getSize()
189     {
190         return $this->getAttribute('size');
191     }
193     /**
194      * Sets the select mutiple attribute
195      *
196      * @param bool $multiple Whether the select supports multi-selections
197      */
198     function setMultiple($multiple)
199     {
200         if ($multiple) {
201             $this->updateAttributes(array('multiple' => 'multiple'));
202         } else {
203             $this->removeAttribute('multiple');
204         }
205     }
207     /**
208      * Returns the select mutiple attribute
209      *
210      * @return bool true if multiple select, false otherwise
211      */
212     function getMultiple()
213     {
214         return (bool)$this->getAttribute('multiple');
215     }
217     /**
218      * Loads the options from an associative array
219      *
220      * @param array $arr Associative array of options
221      * @param mixed $values (optional) Array or comma delimited string of selected values
222      * @return PEAR_Error|bool on error or true
223      * @throws PEAR_Error
224      */
225     function loadArrayOptGroups($arr, $values=null)
226     {
227         if (!is_array($arr)) {
228             return self::raiseError('Argument 1 of HTML_Select::loadArrayOptGroups is not a valid array');
229         }
230         if (isset($values)) {
231             $this->setSelected($values);
232         }
233         foreach ($arr as $key => $val) {
234             // Warning: new API since release 2.3
235             $this->addOptGroup($key, $val);
236         }
237         return true;
238     }
240     /**
241      * Adds a new OPTION to the SELECT
242      *
243      * @param string $text Display text for the OPTION
244      * @param string $value Value for the OPTION
245      * @param mixed $attributes Either a typical HTML attribute string
246      *              or an associative array
247      */
248     function addOptGroup($text, $value, $attributes=null)
249     {
250         if (null === $attributes) {
251             $attributes = array('label' => $text);
252         } else {
253             $attributes = $this->_parseAttributes($attributes);
254             $this->_updateAttrArray($attributes, array('label' => $text));
255         }
256         $index = count($this->_optGroups);
257         $this->_optGroups[$index] = array('attr' => $attributes);
258         $this->loadArrayOptions($index, $value);
259     }
261     /**
262      * Loads the options from an associative array
263      *
264      * @param string $optgroup name of the options group
265      * @param array $arr Associative array of options
266      * @param mixed $values (optional) Array or comma delimited string of selected values
267      * @return PEAR_Error|bool on error or true
268      * @throws PEAR_Error
269      */
270     function loadArrayOptions($optgroup, $arr, $values=null)
271     {
272         if (!is_array($arr)) {
273             return self::raiseError('Argument 1 of HTML_Select::loadArray is not a valid array');
274         }
275         if (isset($values)) {
276             $this->setSelected($values);
277         }
278         foreach ($arr as $key => $val) {
279             // Warning: new API since release 2.3
280             $this->addOption($optgroup, $val, $key);
281         }
282         return true;
283     }
285     /**
286      * Adds a new OPTION to an optgroup
287      *
288      * @param string $optgroup name of the option group
289      * @param string $text Display text for the OPTION
290      * @param string $value Value for the OPTION
291      * @param mixed $attributes Either a typical HTML attribute string
292      *              or an associative array
293      */
294     function addOption($optgroup, $text, $value, $attributes=null)
295     {
296         if (null === $attributes) {
297             $attributes = array('value' => $value);
298         } else {
299             $attributes = $this->_parseAttributes($attributes);
300             if (isset($attributes['selected'])) {
301                 // the 'selected' attribute will be set in toHtml()
302                 $this->_removeAttr('selected', $attributes);
303                 if (is_null($this->_values)) {
304                     $this->_values = array($value);
305                 } elseif (!in_array($value, $this->_values)) {
306                     $this->_values[] = $value;
307                 }
308             }
309             $this->_updateAttrArray($attributes, array('value' => $value));
310         }
311         $this->_optGroups[$optgroup]['options'][] = array('text' => $text, 'attr' => $attributes);
312     }
314     /**
315      * Returns the SELECT in HTML
316      *
317      * @return string
318      */
319     function toHtml()
320     {
321         if ($this->_flagFrozen) {
322             return $this->getFrozenHtml();
323         } else {
324             $tabs    = $this->_getTabs();
325             $strHtml = '';
327             if ($this->getComment() != '') {
328                 $strHtml .= $tabs . '<!-- ' . $this->getComment() . " //-->\n";
329             }
331             if (!$this->getMultiple()) {
332                 $attrString = $this->_getAttrString($this->_attributes);
333             } else {
334                 $myName = $this->getName();
335                 $this->setName($myName . '[]');
336                 $attrString = $this->_getAttrString($this->_attributes);
337                 $this->setName($myName);
338             }
339             $strHtml .= $tabs;
340             if ($this->_hiddenLabel){
341                 $this->_generateId();
342                 $strHtml .= '<label class="accesshide" for="'.$this->getAttribute('id').'" >'.
343                             $this->getLabel().'</label>';
344             }
345             $strHtml .=  '<select' . $attrString . ">\n";
346             if ($this->showchoose) {
347                 $strHtml .= $tabs . "\t\t<option value=\"\">" . get_string('choose') . "...</option>\n";
348             }
349             foreach ($this->_optGroups as $optGroup) {
350                 if (empty($optGroup['options'])) {
351                     //xhtml strict
352                     continue;
353                 }
354                 $strHtml .= $tabs . "\t<optgroup" . ($this->_getAttrString($optGroup['attr'])) . '>';
355                 foreach ($optGroup['options'] as $option){
356                     if (is_array($this->_values) && in_array((string)$option['attr']['value'], $this->_values)) {
357                         $this->_updateAttrArray($option['attr'], array('selected' => 'selected'));
358                     }
359                     $strHtml .= $tabs . "\t\t<option" . $this->_getAttrString($option['attr']) . '>' .
360                                 $option['text'] . "</option>\n";
361                 }
362                 $strHtml .= $tabs . "\t</optgroup>\n";
363             }
364             return $strHtml . $tabs . '</select>';
365         }
366     }
368     /**
369      * Returns the value of field without HTML tags
370      *
371      * @return string
372      */
373     function getFrozenHtml()
374     {
375         $value = array();
376         if (is_array($this->_values)) {
377             foreach ($this->_values as $key => $val) {
378                 foreach ($this->_optGroups as $optGroup) {
379                     for ($i = 0, $optCount = count($optGroup['options']); $i < $optCount; $i++) {
380                         if ((string)$val == (string)$optGroup['options'][$i]['attr']['value']) {
381                             $value[$key] = $optGroup['options'][$i]['text'];
382                             break;
383                         }
384                     }
385                 }
386             }
387         }
388         $html = empty($value)? '&nbsp;': join('<br />', $value);
389         if ($this->_persistantFreeze) {
390             $name = $this->getPrivateName();
391             // Only use id attribute if doing single hidden input
392             if (1 == count($value)) {
393                 $id     = $this->getAttribute('id');
394                 $idAttr = isset($id)? array('id' => $id): array();
395             } else {
396                 $idAttr = array();
397             }
398             foreach ($value as $key => $item) {
399                 $html .= '<input' . $this->_getAttrString(array(
400                              'type'  => 'hidden',
401                              'name'  => $name,
402                              'value' => $this->_values[$key]
403                          ) + $idAttr) . ' />';
404             }
405         }
406         return $html;
407     }
409    /**
410     * We check the options and return only the values that _could_ have been
411     * selected. We also return a scalar value if select is not "multiple"
412     *
413     * @param array $submitValues submitted values
414     * @param bool $assoc if true the retured value is associated array
415     * @return mixed
416     */
417     function exportValue(&$submitValues, $assoc = false)
418     {
419         if (empty($this->_optGroups)) {
420             return $this->_prepareValue(null, $assoc);
421         }
423         $value = $this->_findValue($submitValues);
424         if (is_null($value)) {
425             $value = $this->getValue();
426         }
427         $value = (array)$value;
429         $cleaned = array();
430         foreach ($value as $v) {
431             foreach ($this->_optGroups as $optGroup){
432                 if (empty($optGroup['options'])) {
433                     continue;
434                 }
435                 foreach ($optGroup['options'] as $option) {
436                     if ((string)$option['attr']['value'] === (string)$v) {
437                         $cleaned[] = (string)$option['attr']['value'];
438                         break;
439                     }
440                 }
441             }
442         }
444         if (empty($cleaned)) {
445             return $this->_prepareValue(null, $assoc);
446         }
447         if ($this->getMultiple()) {
448             return $this->_prepareValue($cleaned, $assoc);
449         } else {
450             return $this->_prepareValue($cleaned[0], $assoc);
451         }
452     }
454     /**
455      * Called by HTML_QuickForm whenever form event is made on this element
456      *
457      * @param string $event Name of event
458      * @param mixed $arg event arguments
459      * @param object $caller calling object
460      * @return bool
461      */
462     function onQuickFormEvent($event, $arg, &$caller)
463     {
464         if ('updateValue' == $event) {
465             $value = $this->_findValue($caller->_constantValues);
466             if (null === $value) {
467                 $value = $this->_findValue($caller->_submitValues);
468                 // Fix for bug #4465 & #5269
469                 // XXX: should we push this to element::onQuickFormEvent()?
470                 if (null === $value && (!$caller->isSubmitted() || !$this->getMultiple())) {
471                     $value = $this->_findValue($caller->_defaultValues);
472                 }
473             }
474             if (null !== $value) {
475                 $this->setValue($value);
476             }
477             return true;
478         } else {
479             return parent::onQuickFormEvent($event, $arg, $caller);
480         }
481     }
483     /**
484      * Sets label to be hidden
485      *
486      * @param bool $hiddenLabel sets if label should be hidden
487      */
488     function setHiddenLabel($hiddenLabel){
489         $this->_hiddenLabel = $hiddenLabel;
490     }
492     /**
493      * get html for help button
494      *
495      * @return string html for help button
496      */
497     function getHelpButton(){
498         return $this->_helpbutton;
499     }
501     /**
502      * Slightly different container template when frozen. Don't want to use a label tag
503      * with a for attribute in that case for the element label but instead use a div.
504      * Templates are defined in renderer constructor.
505      *
506      * @return string
507      */
508     function getElementTemplateType(){
509         if ($this->_flagFrozen){
510             return 'static';
511         } else {
512             return 'default';
513         }
514     }
516     public function export_for_template(renderer_base $output) {
517         $context = $this->export_for_template_base($output);
518         $optiongroups = [];
519         if ($this->showchoose) {
520             $optionsgroups[] = [
521                 'text' => get_string('choosedots')
522             ];
523         }
525         // Standard option attributes.
526         $standardoptionattributes = ['text', 'value', 'selected', 'disabled'];
527         foreach ($this->_optGroups as $group) {
528             $options = [];
530             foreach ($group['options'] as $option) {
531                 $o = ['value' => (string)$option['attr']['value']];
532                 if (is_array($this->_values) && in_array($o['value'], $this->_values)) {
533                     $o['selected'] = true;
534                 } else {
535                     $o['selected'] = false;
536                 }
537                 $o['text'] = $option['text'];
538                 $o['disabled'] = !empty($option['attr']['disabled']);
539                 // Set other attributes.
540                 $otheroptionattributes = [];
541                 foreach ($option['attr'] as $attr => $value) {
542                     if (!in_array($attr, $standardoptionattributes) && $attr != 'class' && !is_object($value)) {
543                         $otheroptionattributes[] = $attr . '="' . s($value) . '"';
544                     }
545                 }
546                 $o['optionattributes'] = implode(' ', $otheroptionattributes);
547                 $options[] = $o;
548             }
550             $og = [
551                 'text' => $group['attr']['label'],
552                 'options' => $options
553             ];
555             $optiongroups[] = $og;
556         }
557         $context['optiongroups'] = $optiongroups;
559         return $context;
560     }