| 1441 |
ariadna |
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 |
namespace core\output;
|
|
|
18 |
|
|
|
19 |
/**
|
|
|
20 |
* Interface marking other classes having the ability to export their data for use by templates.
|
|
|
21 |
*
|
|
|
22 |
* @copyright 2015 Damyon Wiese
|
|
|
23 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
24 |
* @package core
|
|
|
25 |
* @category output
|
|
|
26 |
* @since 2.9
|
|
|
27 |
*/
|
|
|
28 |
interface templatable {
|
|
|
29 |
/**
|
|
|
30 |
* Function to export the renderer data in a format that is suitable for a
|
|
|
31 |
* mustache template. This means:
|
|
|
32 |
* 1. No complex types - only stdClass, array, int, string, float, bool
|
|
|
33 |
* 2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
|
|
|
34 |
*
|
|
|
35 |
* @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
|
|
|
36 |
* @return \stdClass|array
|
|
|
37 |
*/
|
|
|
38 |
public function export_for_template(renderer_base $output);
|
|
|
39 |
}
|
|
|
40 |
|
|
|
41 |
// Alias this class to the old name.
|
|
|
42 |
// This file will be autoloaded by the legacyclasses autoload system.
|
|
|
43 |
// In future all uses of this class will be corrected and the legacy references will be removed.
|
|
|
44 |
class_alias(templatable::class, \templatable::class);
|