Output renderers
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Output renderers | |
---|---|
Project state | Specification |
Tracker issue | MDL-20204 |
Discussion | n/a |
Assignee | Petr Škoda (škoďák) + David Mudrak + feedback and ideas from other developers |
Moodle 2.0
Goals
- stable API
- easy to use
- easy to customise via themes
Renderers
Output renderer is a class with collection of methods that handle rendering of visual aspects of Moodle pages, emails, html export, etc. In 1.9 general output related functions were located in weblib.php and modules stored rendering code in lib.php, locallib.php, view.php, etc.
Output renderer instances are obtained through moodle_page::get_renderer($component, $subtype = null, $target = null) method. Current core_renderer is available through the global $OUTPUT variable, please note this global should not be used in low level APIs and scripts like cron.
Renderer targets
renderer_base
Abstract class every other renderer must extend. Renderer base implements basic methods and support for renderer dispatching. The most important method is: {code php} public function render(widget $widget) {code}
This method uses $widget class to find fine correct protected rendering method.
core_renderer
For example user avatar rendering involves following methods and classes: {code php} class core_renderer extends renderer_base {
public function render(widget $widget) { // calls $this->render_user_image($widget) when parameter with class user_image submitted } protected function (user_image $user_image) { // returns html markup for user avatar } public function user_image($userrecord, $courseid, $lin) { // helper method that constructs $user_image widget and calls $this->render }
} {code}