MDL-55417 forms: Render form elements with a template

This change allows form elements to be overridden with a mustache template.
The template can even listen for form validation errors and supply the JS to
change the look of the form element when there is/isn't a validation error.

Initial support is for all core form elements including:

text, select, selectyesno and checkboxes, groups, dateselector, datetimeselector,
autocomplete, modvisible, advcheckbox, button, duration, filemanager, filepicker, editor, static, grading,
warning, textarea, password, url, submit, questioncategory, recaptcha.

Part of MDL-55071
This commit is contained in:
Damyon Wiese
2016-09-23 10:53:30 +01:00
committed by Dan Poltawski
parent ef18a21f93
commit 91bda4cd45
69 changed files with 1566 additions and 367 deletions
+46 -1
View File
@@ -26,6 +26,7 @@
*/
require_once('HTML/QuickForm/element.php');
require_once(__DIR__ . '/../outputcomponents.php');
/**
* select type form element
@@ -37,7 +38,7 @@ require_once('HTML/QuickForm/element.php');
* @copyright 2007 Jamie Pratt <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class MoodleQuickForm_selectgroups extends HTML_QuickForm_element {
class MoodleQuickForm_selectgroups extends HTML_QuickForm_element implements templatable {
/** @var bool add choose option */
var $showchoose = false;
@@ -507,4 +508,48 @@ class MoodleQuickForm_selectgroups extends HTML_QuickForm_element {
return 'default';
}
}
public function export_for_template(renderer_base $output) {
$context = [];
$context['frozen'] = $this->_flagFrozen;
$context['attributes'] = [];
foreach ($this->getAttributes() as $name => $value) {
$context[$name] = $value;
if (!in_array($name, ['id', 'name', 'multiple'])) {
$context['attributes'][] = ['name' => $name, 'value' => $value];
}
}
$optiongroups = [];
if ($this->showchoose) {
$optionsgroups[] = [
'text' => get_string('choosedots')
];
}
foreach ($this->_optGroups as $group) {
$options = [];
foreach ($group['options'] as $option) {
$o = [];
if (is_array($this->_values) && in_array((string)$option['attr']['value'], $this->_values)) {
$o['selected'] = true;
} else {
$o['selected'] = false;
}
$o['text'] = $option['text'];
$options[] = $o;
}
$og = [
'text' => $group['attr']['label'],
'options' => $options
];
$optiongroups[] = $og;
}
$context['optiongroups'] = $optiongroups;
$context['hideLabel'] = $this->_hiddenLabel;
return $context;
}
}