6b4e78c2df6ae2a65deef33cc26ed5f5309826be
[moodle.git] / lib / outputfactories.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Interface and classes for creating appropriate renderers for various
20  * parts of Moodle.
21  *
22  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
23  * for an overview.
24  *
25  * @package   moodlecore
26  * @copyright 2009 Tim Hunt
27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 /** General rendering target, usually normal browser page */
31 define('RENDERER_TARGET_GENERAL', 'general');
33 /** Plain text rendering for CLI scripts and cron */
34 define('RENDERER_TARGET_CLI', 'cli');
36 /** Plain text rendering intended for sending via email */
37 define('RENDERER_TARGET_TEXTEMAIL', 'textemail');
39 /** Rich text html rendering intended for sending via email */
40 define('RENDERER_TARGET_HTMLEMAIL', 'htmlemail');
42 /* note: maybe we could define portfolio export target too */
45 /**
46  * A renderer factory is just responsible for creating an appropriate renderer
47  * for any given part of Moodle.
48  *
49  * Which renderer factory to use is chose by the current theme, and an instance
50  * if created automatically when the theme is set up.
51  *
52  * A renderer factory must also have a constructor that takes a theme_config object.
53  * (See {@link renderer_factory_base::__construct} for an example.)
54  *
55  * @copyright 2009 Tim Hunt
56  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57  * @since     Moodle 2.0
58  */
59 interface renderer_factory {
60     /**
61      * Return the renderer for a particular part of Moodle.
62      *
63      * The renderer interfaces are defined by classes called {plugin}_renderer
64      * where {plugin} is the name of the component. The renderers for core Moodle are
65      * defined in lib/renderer.php. For plugins, they will be defined in a file
66      * called renderer.php inside the plugin.
67      *
68      * Renderers will normally want to subclass the renderer_base class.
69      * (However, if you really know what you are doing, you don't have to do that.)
70      *
71      * There is no separate interface definition for renderers. The default
72      * {plugin}_renderer implementation also serves to define the API for
73      * other implementations of the interface, whether or not they subclass it.
74      *
75      * A particular plugin can define multiple renderers if it wishes, using the
76      * $subtype parameter. For example workshop_renderer,
77      * workshop_allocation_manual_renderer etc.
78      *
79      * @param moodle_page $page the page the renderer is outputting content for.
80      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
81      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
82      * @param string $target one of rendering target constants
83      * @return object an object implementing the requested renderer interface.
84      */
85     public function get_renderer(moodle_page $page, $component, $subtype=null, $target=null);
86 }
89 /**
90  * This is a base class to help you implement the renderer_factory interface.
91  *
92  * It keeps a cache of renderers that have been constructed, so you only need
93  * to construct each one once in you subclass.
94  *
95  * It also has a method to get the name of, and include the renderer.php with
96  * the definition of, the standard renderer class for a given module.
97  *
98  * @copyright 2009 Tim Hunt
99  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
100  * @since     Moodle 2.0
101  */
102 abstract class renderer_factory_base implements renderer_factory {
103     /** @var theme_config the theme we belong to. */
104     protected $theme;
106     /** @var hardcoded list of core subtypes and their locations, add more if ├čneeded */
107     protected $core_subtypes = array('webservice' => 'webservice');
109     /**
110      * Constructor.
111      * @param theme_config $theme the theme we belong to.
112      */
113     public function __construct(theme_config $theme) {
114         $this->theme = $theme;
115     }
117     /**
118      * Returns suffix of renderer class expected for given target.
119      * @param string $target one of the renderer target constants, target is guessed if null used
120      * @return array two element array, first element is target, second the target suffix string
121      */
122     protected function get_target_suffix($target) {
123         if (empty($target) and CLI_SCRIPT) {
124             // automatically guessed default for all CLI scripts
125             $target = RENDERER_TARGET_CLI;
126         }
128         switch ($target) {
129             case RENDERER_TARGET_CLI: $suffix = '_cli'; break;
130             case RENDERER_TARGET_TEXTEMAIL: $suffix = '_textemail'; break;
131             case RENDERER_TARGET_HTMLEMAIL: $suffix = '_htmlemail'; break;
132             default: $target = RENDERER_TARGET_GENERAL; $suffix = '';
133         }
135         return array($target, $suffix);
136     }
138     /**
139      * For a given module name, return the name of the standard renderer class
140      * that defines the renderer interface for that module.
141      *
142      * Also, if it exists, include the renderer.php file for that module, so
143      * the class definition of the default renderer has been loaded.
144      *
145      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
146      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
147      * @return string the name of the standard renderer class for that module.
148      */
149     protected function standard_renderer_classname($component, $subtype = null) {
150         global $CFG; // needed in incldued files
152         if ($component !== 'core') {
153             // standardize component names
154             if (strpos($component, '_') === false) {
155                 $component = 'mod_' . $component;
156             }
157             // renderers are stored in renderer.php files
158             if (!$compdirectory = get_component_directory($component)) {
159                 throw new coding_exception('Invalid component specified in renderer request');
160             }
161             $rendererfile = $compdirectory . '/renderer.php';
162             if (file_exists($rendererfile)) {
163                 include_once($rendererfile);
164             }
166         } else if (!empty($subtype)) {
167             if (!isset($this->core_subtypes[$subtype])) {
168                 throw new coding_exception('Invalid core subtype "' . $subtype . '" in renderer request');
169             }
170             $rendererfile = $CFG->dirroot . '/' . $this->core_subtypes[$subtype] . '/renderer.php';
171             if (file_exists($rendererfile)) {
172                 include_once($rendererfile);
173             }
174         }
176         if (empty($subtype)) {
177             $class = $component . '_renderer';
178         } else {
179             $class = $component . '_' . $subtype . '_renderer';
180         }
181         return $class;
182     }
186 /**
187  * This is the default renderer factory for Moodle. It simply returns an instance
188  * of the appropriate standard renderer class.
189  *
190  * @copyright 2009 Tim Hunt
191  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
192  * @since     Moodle 2.0
193  */
194 class standard_renderer_factory extends renderer_factory_base {
195     /**
196      * Implement the subclass method
197      * @param moodle_page $page the page the renderer is outputting content for.
198      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
199      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
200      * @param string $target one of rendering target constants
201      * @return object an object implementing the requested renderer interface.
202      */
203     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
204         $classname = $this->standard_renderer_classname($component, $subtype);
205         if (!class_exists($classname)) {
206             throw new coding_exception('Request for an unknown renderer class ' . $classname);
207         }
209         list($target, $suffix) = $this->get_target_suffix($target);
210         if (class_exists($classname . $suffix)) {
211             // use the specialised renderer for given target, default renderer might also decide
212             // to implement support for more targets
213             $classname = $classname . $suffix;
214         }
216         return new $classname($page, $target);
217     }
221 /**
222  * This is renderer factory allows themes to override the standard renderers using
223  * php code.
224  *
225  * It will load any code from theme/mytheme/renderers.php and
226  * theme/parenttheme/renderers.php, if then exist. Then whenever you ask for
227  * a renderer for 'component', it will create a mytheme_component_renderer or a
228  * parenttheme_component_renderer, instead of a component_renderer,
229  * if either of those classes exist.
230  *
231  * @copyright 2009 Tim Hunt
232  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
233  * @since     Moodle 2.0
234  */
235 class theme_overridden_renderer_factory extends renderer_factory_base {
237     protected $prefixes = array();
239     /**
240      * Constructor.
241      * @param object $theme the theme we are rendering for.
242      */
243     public function __construct(theme_config $theme) {
244         parent::__construct($theme);
245         // Initialise $this->prefixes.
246         $this->prefixes = $theme->renderer_prefixes();
247     }
249     /**
250      * Implement the subclass method
251      * @param moodle_page $page the page the renderer is outputting content for.
252      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
253      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
254      * @param string $target one of rendering target constants
255      * @return object an object implementing the requested renderer interface.
256      */
257     public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
258         $classname = $this->standard_renderer_classname($component, $subtype);
259         if (!class_exists($classname)) {
260             // standard renderer must always exist
261             throw new coding_exception('Request for an unknown renderer class ' . $classname);
262         }
264         list($target, $suffix) = $this->get_target_suffix($target);
266         // theme lib.php and renderers.php files are loaded automatically
267         // when loading the theme configs
269         // first try the renderers with correct suffix
270         foreach ($this->prefixes as $prefix) {
271             if (class_exists($prefix . '_' . $classname . $suffix)) {
272                 $classname = $prefix . '_' . $classname . $suffix;
273                 return new $classname($page, $target);
274             }
275         }
276         if (class_exists($classname . $suffix)) {
277             // use the specialised renderer for given target, default renderer might also decide
278             // to implement support for more targets
279             $classname = $classname . $suffix;
280             return new $classname($page, $target);
281         }
283         // then try general renderer
284         foreach ($this->prefixes as $prefix) {
285             if (class_exists($prefix . '_' . $classname)) {
286                 $classname = $prefix . '_' . $classname;
287                 return new $classname($page, $target);
288             }
289         }
291         return new $classname($page, $target);
292     }