MDL-49152 output: Templates for renderers (JS and PHP)

Mustache support for rendering templates from either php or js.
2015-03-14 22:48:40 +08:00
parent 72f8324ec5
commit 9bdcf57951
66 changed files with 6532 additions and 33 deletions
@@ -0,0 +1,133 @@
+<?php
+// 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/>.
+
+/**
+ * Mustache helper to load strings from string_manager.
+ *
+ * @package    core
+ * @category   output
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\output;
+
+use external_api;
+use external_function_parameters;
+use external_value;
+use core_component;
+use moodle_exception;
+use context_system;
+use theme_config;
+
+/**
+ * This class contains a list of webservice functions related to output.
+ *
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      2.9
+ */
+class external extends external_api {
+    /**
+     * Returns description of load_template() parameters.
+     *
+     * @return external_function_parameters
+     */
+    public static function load_template_parameters() {
+        return new external_function_parameters(
+                array('component' => new external_value(PARAM_COMPONENT, 'component containing the template'),
+                      'template' => new external_value(PARAM_ALPHANUMEXT, 'name of the template'),
+                      'themename' => new external_value(PARAM_ALPHANUMEXT, 'The current theme.'),
+                         )
+            );
+    }
+
+    /**
+     * Can this function be called directly from ajax?
+     *
+     * @return boolean
+     * @since Moodle 2.9
+     */
+    public static function load_template_is_allowed_from_ajax() {
+        return true;
+    }
+
+    /**
+     * Return a mustache template, and all the strings it requires.
+     *
+     * @param string $component The component that holds the template.
+     * @param string $templatename The name of the template.
+     * @param string $themename The name of the current theme.
+     * @return string the template
+     */
+    public static function load_template($component, $template, $themename) {
+        global $DB, $CFG, $PAGE;
+
+        $params = self::validate_parameters(self::load_template_parameters(),
+                                            array('component' => $component,
+                                                  'template' => $template,
+                                                  'themename' => $themename));
+
+        $component = $params['component'];
+        $template = $params['template'];
+        $themename = $params['themename'];
+
+        // Check if this is a valid component.
+        $componentdir = core_component::get_component_directory($component);
+        if (empty($componentdir)) {
+            throw new moodle_exception('filenotfound', 'error');
+        }
+        // Places to look.
+        $candidates = array();
+        // Theme dir.
+        $root = $CFG->dirroot;
+
+        $themeconfig = theme_config::load($themename);
+
+        $candidate = "${root}/theme/${themename}/templates/${component}/${template}.mustache";
+        $candidates[] = $candidate;
+        // Theme parents dir.
+        foreach ($themeconfig->parents as $theme) {
+            $candidate = "${root}/theme/${theme}/templates/${component}/${template}.mustache";
+            $candidates[] = $candidate;
+        }
+        // Component dir.
+        $candidate = "${componentdir}/templates/${template}.mustache";
+        $candidates[] = $candidate;
+        $templatestr = false;
+        foreach ($candidates as $candidate) {
+            if (file_exists($candidate)) {
+                $templatestr = file_get_contents($candidate);
+                break;
+            }
+        }
+        if ($templatestr === false) {
+            throw new moodle_exception('filenotfound', 'error');
+        }
+
+        return $templatestr;
+    }
+
+    /**
+     * Returns description of load_template() result value.
+     *
+     * @return external_description
+     */
+    public static function load_template_returns() {
+        return new external_value(PARAM_RAW, 'template');
+    }
+}
+