Commit 25905de5 authored by Juan Leyva's avatar Juan Leyva
Browse files

MDL-49423 admin: Support optgroup in admin_setting_configselect

parent af1b6043
{{!
This file is part of Moodle - http://moodle.org/
Moodle is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Moodle is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
}}
{{!
@template core_admin/setting_configselect_optgroup
Admin select with optgroup setting template.
Context variables required for this template:
* name - form element name
* id - element id
* options - list of options (not grouped)
* optgroups - list of options grouped containing the group label and for each option: name, value, selected
Example context (json):
{
"name": "test",
"id": "test0",
"options": [
{ "name": "Option 1", "value": "V", "selected": false },
{ "name": "Option 2", "value": "V", "selected": false }
],
"optgroups": [
{
"label": "Group 1",
"options": [
{ "name": "Option 3", "value": "V", "selected": true },
{ "name": "Option 4", "value": "V", "selected": false }
]
},
{
"label": "Group 2",
"options": [
{ "name": "Option 5", "value": "V", "selected": false },
{ "name": "Option 6", "value": "V", "selected": false }
]
}
]
}
}}
<div class="form-select defaultsnext">
<select id="{{id}}" name="{{name}}">
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option>
{{/options}}
{{#optgroups}}
<optgroup label="{{label}}">
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option>
{{/options}}
</optgroup>
{{/optgroups}}
</select>
</div>
This files describes API changes in /admin/*.
=== 3.3 ===
* The admin setting admin_setting_configselect now support the optgroup tag. Grouping of options can be created with this new tag.
For using this new option, the option parameters needs the Group names as indexes:
[
"Spain" => ["madrid" => "Madrid", "barcelona" => "Barcelona"],
"France" => ["paris" => "Paris", "marseille" => "Marseille"],
]
=== 3.2 ===
* Admin settings have been refined to better support right-to-left languages. In RTL,
......
......@@ -2946,6 +2946,8 @@ class admin_setting_configmulticheckbox2 extends admin_setting_configmulticheckb
class admin_setting_configselect extends admin_setting {
/** @var array Array of choices value=>label */
public $choices;
/** @var array Array of choices grouped using optgroups */
public $optgroups;
/**
* Constructor
......@@ -2956,7 +2958,18 @@ class admin_setting_configselect extends admin_setting {
* @param array $choices array of $value=>$label for each selection
*/
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
$this->choices = $choices;
// Look for optgroup and single options.
if (is_array($choices)) {
foreach ($choices as $key => $val) {
if (is_array($val)) {
$this->optgroups[$key] = $val;
$this->choices = array_merge($this->choices, $val);
} else {
$this->choices[$key] = $val;
}
}
}
parent::__construct($name, $visiblename, $description, $defaultsetting);
}
......@@ -3089,6 +3102,27 @@ class admin_setting_configselect extends admin_setting {
}
$options = [];
$template = 'core_admin/setting_configselect';
if (!empty($this->optgroups)) {
$optgroups = [];
foreach ($this->optgroups as $label => $choices) {
$optgroup = array('label' => $label, 'options' => []);
foreach ($choices as $value => $name) {
$optgroup['options'][] = [
'value' => $value,
'name' => $name,
'selected' => (string) $value == $data
];
unset($this->choices[$value]);
}
$optgroups[] = $optgroup;
}
$context->options = $options;
$context->optgroups = $optgroups;
$template = 'core_admin/setting_configselect_optgroup';
}
foreach ($this->choices as $value => $name) {
$options[] = [
'value' => $value,
......@@ -3098,7 +3132,7 @@ class admin_setting_configselect extends admin_setting {
}
$context->options = $options;
$element = $OUTPUT->render_from_template('core_admin/setting_configselect', $context);
$element = $OUTPUT->render_from_template($template, $context);
return format_admin_setting($this, $this->visiblename, $element, $this->description, true, $warning, $defaultinfo, $query);
}
......
{{!
This file is part of Moodle - http://moodle.org/
Moodle is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Moodle is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
}}
{{!
Setting configselect with optgroup support.
}}
<div class="form-select defaultsnext">
<select id="{{id}}" name="{{name}}" class="custom-select">
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option>
{{/options}}
{{#optgroups}}
<optgroup label="{{label}}">
{{#options}}
<option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option>
{{/options}}
</optgroup>
{{/optgroups}}
</select>
</div>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment