L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-78916 core_form: allow class overrides on button form element

Browse Source 
This works the same as the customclassoverride on the submit element,
in that only the 'btn' class is hard coded in the template. Passing
$options['customclassoverride'] to the constructor allows calling code
to specify other classes to be added beside 'btn'. E.g. 'btn-primary'.
If no options array is passed, 'btn-secondary' is used (the existing
class used for button elements).
This commit is contained in:
Jake Dallimore
2023-09-13 17:37:06 +08:00
parent bf3f13fea6
commit 893ce4f7b2
3 changed files with 35 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/form/button.php
+29 -2
View File
@@ -41,7 +41,9 @@ require_once('templatable_form_element.php');
*/
class MoodleQuickForm_button extends HTML_QuickForm_button implements templatable
{
use templatable_form_element;
use templatable_form_element {
export_for_template as export_for_template_base;
}
/** @var string html for help button, if empty then no help */
var $_helpbutton='';
@@ -49,6 +51,17 @@ class MoodleQuickForm_button extends HTML_QuickForm_button implements templatabl
/** @var bool if true label will be hidden. */
protected $_hiddenLabel = false;
/**
* Any class apart from 'btn' would be overridden with this content.
*
* By default, buttons will utilize the btn-secondary class. However, there are cases where we
* require a button with different stylings (e.g. btn-primary). In these cases, $customclassoverride will override
* the defaults mentioned previously and utilize the provided class(es).
*
* @var null|string $customclassoverride Custom class override for the input element
*/
protected $customclassoverride;
/**
* constructor
*
@@ -56,9 +69,14 @@ class MoodleQuickForm_button extends HTML_QuickForm_button implements templatabl
* @param string $value (optional) value for the button
* @param mixed $attributes (optional) Either a typical HTML attribute string
* or an associative array
* @param array $options Options to further customise the button. Currently accepted options are:
* customclassoverride String The CSS class to use for the button instead of the standard
* btn-primary and btn-secondary classes.
*/
public function __construct($elementName=null, $value=null, $attributes=null) {
public function __construct($elementName=null, $value=null, $attributes=null, $options = []) {
parent::__construct($elementName, $value, $attributes);
$this->customclassoverride = $options['customclassoverride'] ?? null;
}
/**
@@ -101,4 +119,13 @@ class MoodleQuickForm_button extends HTML_QuickForm_button implements templatabl
public function setHiddenLabel($hiddenLabel) {
$this->_hiddenLabel = $hiddenLabel;
}
public function export_for_template(renderer_base $output) {
$context = $this->export_for_template_base($output);
if ($this->customclassoverride) {
$context['customclassoverride'] = $this->customclassoverride;
}
return $context;
}
}