1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Perform some custom name mapping for template file names (strip leading component/).
|
|
|
19 |
*
|
|
|
20 |
* @package core
|
|
|
21 |
* @category output
|
|
|
22 |
* @copyright 2015 Damyon Wiese
|
|
|
23 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
24 |
*/
|
|
|
25 |
|
|
|
26 |
namespace core\output;
|
|
|
27 |
|
|
|
28 |
use coding_exception;
|
|
|
29 |
|
|
|
30 |
/**
|
|
|
31 |
* Perform some custom name mapping for template file names.
|
|
|
32 |
*
|
|
|
33 |
* @copyright 2015 Damyon Wiese
|
|
|
34 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
35 |
* @since 2.9
|
|
|
36 |
*/
|
|
|
37 |
class mustache_filesystem_loader extends \Mustache_Loader_FilesystemLoader {
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Provide a default no-args constructor (we don't really need anything).
|
|
|
41 |
*/
|
|
|
42 |
public function __construct() {
|
|
|
43 |
}
|
|
|
44 |
|
|
|
45 |
/**
|
|
|
46 |
* Helper function for getting a Mustache template file name.
|
|
|
47 |
* Uses the leading component to restrict us specific directories.
|
|
|
48 |
*
|
|
|
49 |
* @param string $name
|
|
|
50 |
* @return string Template file name
|
|
|
51 |
*/
|
|
|
52 |
protected function getFileName($name) {
|
|
|
53 |
// Call the Moodle template finder.
|
|
|
54 |
return mustache_template_finder::get_template_filepath($name);
|
|
|
55 |
}
|
|
|
56 |
|
|
|
57 |
/**
|
|
|
58 |
* Only check if baseDir is a directory and requested templates are files if
|
|
|
59 |
* baseDir is using the filesystem stream wrapper.
|
|
|
60 |
*
|
|
|
61 |
* Always check path for mustache_filesystem_loader.
|
|
|
62 |
*
|
|
|
63 |
* @return bool Whether to check `is_dir` and `file_exists`
|
|
|
64 |
*/
|
|
|
65 |
protected function shouldCheckPath() {
|
|
|
66 |
return true;
|
|
|
67 |
}
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Load a Template by name.
|
|
|
71 |
*
|
|
|
72 |
* @param string $name the template name
|
|
|
73 |
* @return string Mustache Template source
|
|
|
74 |
*/
|
|
|
75 |
public function load($name) {
|
|
|
76 |
global $CFG;
|
|
|
77 |
if (!empty($CFG->debugtemplateinfo)) {
|
|
|
78 |
// We use many templates per page. We don't want to allocate more memory than necessary.
|
|
|
79 |
return "<!-- template(PHP): $name -->" . parent::load($name) . "<!-- /template(PHP): $name -->";
|
|
|
80 |
}
|
|
|
81 |
return parent::load($name);
|
|
|
82 |
}
|
|
|
83 |
}
|