renderer_factory Interface Reference

Inheritance diagram for renderer_factory:

Public Member Functions
	get_renderer (moodle_page $page, $component, $subtype=null, $target=null)
	Return the renderer for a particular part of Moodle. More...

Member Function Documentation

get_renderer()

renderer_factory::get_renderer	(	moodle_page	$page,
			$component,
			$subtype = null,
			$target = null
	)

Return the renderer for a particular part of Moodle.

The renderer interfaces are defined by classes called {plugin}_renderer where {plugin} is the name of the component. The renderers for core Moodle are defined in lib/renderer.php. For plugins, they will be defined in a file called renderer.php inside the plugin.

Renderers will normally want to subclass the renderer_base class. (However, if you really know what you are doing, you don't have to do that.)

There is no separate interface definition for renderers. The default {plugin}_renderer implementation also serves to define the API for other implementations of the interface, whether or not they subclass it.

A particular plugin can define multiple renderers if it wishes, using the $subtype parameter. For example workshop_renderer, workshop_allocation_manual_renderer etc.

Parameters

moodle_page	$page	the page the renderer is outputting content for.
string	$component	name such as 'core', 'mod_forum' or 'qtype_multichoice'.
string	$subtype	optional subtype such as 'news' resulting to 'mod_forum_news'
string	$target	one of rendering target constants

Return values

renderer_base

an object implementing the requested renderer interface.

Implemented in standard_renderer_factory, and theme_overridden_renderer_factory.

---

The documentation for this interface was generated from the following file:

• lib/outputfactories.php