MDL-55479 output: Single button uses templates

Part of MDL-55071

Author: Frederic Massart

lib/outputcomponents.php

@@ -713,6 +713,49 @@ public function add_confirm_action($confirmmessage) {
     public function add_action(component_action $action) {
         $this->actions[] = $action;
     }
+
+    /**
+     * Export data.
+     *
+     * @param renderer_base $output Renderer.
+     * @return stdClass
+     */
+    public function export_for_template(renderer_base $output) {
+        $url = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
+
+        $data = new stdClass();
+        $data->id = html_writer::random_id('single_button');
+        $data->formid = $this->formid;
+        $data->method = $this->method;
+        $data->url = $url === '' ? '#' : $url;
+        $data->label = $this->label;
+        $data->classes = $this->class;
+        $data->disabled = $this->disabled;
+        $data->tooltip = $this->tooltip;
+
+        // Form parameters.
+        $params = $this->url->params();
+        if ($this->method === 'post') {
+            $params['sesskey'] = sesskey();
+        }
+        $data->params = array_map(function($key) use ($params) {
+            return ['name' => $key, 'value' => $params[$key]];
+        }, array_keys($params));
+
+        // Button actions.
+        $actions = $this->actions;
+        $data->actions = array_map(function($key) use ($actions) {
+            $args = !empty($actions[$key]->jsfunctionargs) ? json_encode($actions[$key]->jsfunctionargs) : false;
+            return [
+                'event' => $actions[$key]->event,
+                'jsfunction' => $actions[$key]->jsfunction,
+                'jsfunctionargs' => $args,
+            ];
+        }, array_keys($actions));
+        $data->hasactions = !empty($data->actions);
+
+        return $data;
+    }
 }
 
 

theme/noname/classes/output/core_renderer.php

@@ -28,6 +28,7 @@
 use preferences_groups;
 use action_menu;
 use help_icon;
+use single_button;
 use single_select;
 use paging_bar;
 use url_select;
@@ -276,6 +277,18 @@ protected function render_help_icon(help_icon $helpicon) {
         return $this->render_from_template('core/help_icon', $context);
     }
 
+    /**
+     * Renders a single button widget.
+     *
+     * This will return HTML to display a form containing a single button.
+     *
+     * @param single_button $button
+     * @return string HTML fragment
+     */
+    protected function render_single_button(single_button $button) {
+        return $this->render_from_template('core/single_button', $button->export_for_template($this));
+    }
+
     /**
      * Renders a single select.
      *

theme/noname/templates/core/single_button.mustache

@@ -0,0 +1,20 @@
+<div class="{{classes}}">
+    <form method="{{method}}" action="{{url}}" id="{{formid}}">
+        {{#params}}
+            <input type="hidden" name="{{name}}" value="{{value}}">
+        {{/params}}
+        <button type="submit" class="btn btn-secondary"
+            id="{{id}}"
+            title={{#quote}}{{tooltip}}{{/quote}}
+            {{#disabled}}disabled{{/disabled}}>{{label}}</button>
+    </form>
+</div>
+{{#hasactions}}
+    {{#js}}
+        require(['core/yui'], function(Y) {
+            {{#actions}}
+                Y.on('{{event}}', {{{jsfunction}}}, '#{{id}}', null{{#jsfunctionargs}}, {{{jsfunctionargs}}}{{/jsfunctionargs}});
+            {{/actions}}
+        });
+    {{/js}}
+{{/hasactions}}