core_h5p\output\renderer Class Reference

Inheritance diagram for core_h5p\output\renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.
	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.
	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.
	get_page ()
	Returns the moodle page object.
	h5p_alter_filtered_parameters (&$parameters, string $name, int $majorversion, int $minorversion)
	Alter parameters of H5P content after it has been filtered through semantics.
	h5p_alter_scripts (&$scripts, array $libraries, string $embedtype)
	Alter which scripts are loaded for H5P.
	h5p_alter_semantics (&$semantics, $name, $majorversion, $minorversion)
	Alter semantics before they are processed.
	h5p_alter_styles (&$styles, array $libraries, string $embedtype)
	Alter which stylesheets are loaded for H5P.
	has_started ()
	Returns true is output has already started, and false if not.
	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.
	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.
	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.
	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class.

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.
renderer_base core_renderer	$output
	A reference to the current renderer.
moodle_page	$page
	The Moodle page the renderer has been created to assist with.
string	$target
	The requested rendering target.
array	$templatecache = []
	$templatecache The mustache template cache.

Member Function Documentation

h5p_alter_filtered_parameters()

core_h5p\output\renderer::h5p_alter_filtered_parameters	(	&	$parameters,
		string	$name,
		int	$majorversion,
		int	$minorversion )

Alter parameters of H5P content after it has been filtered through semantics.

This is useful for adapting the content to the current context.

Parameters

array | object	$parameters	The content parameters for the library
string	$name	The machine readable name of the library
int	$majorversion	Major version of the library
int	$minorversion	Minor version of the library

h5p_alter_scripts()

core_h5p\output\renderer::h5p_alter_scripts	(	&	$scripts,
		array	$libraries,
		string	$embedtype )

Alter which scripts are loaded for H5P.

This is useful for adding custom scripts or replacing existing ones.

Parameters

array | object	$scripts	List of JavaScripts that will be loaded
array	$libraries	Array of libraries indexed by the library's machineName
string	$embedtype	Possible values: div, iframe, external, editor

h5p_alter_semantics()

core_h5p\output\renderer::h5p_alter_semantics	(	&	$semantics,
			$name,
			$majorversion,
			$minorversion )

Alter semantics before they are processed.

This is useful for changing how the editor looks and how content parameters are filtered.

Parameters

object | object	$semantics	Semantics as object
string	$name	Machine name of library
int	$majorversion	Major version of library
int	$minorversion	Minor version of library

h5p_alter_styles()

core_h5p\output\renderer::h5p_alter_styles	(	&	$styles,
		array	$libraries,
		string	$embedtype )

Alter which stylesheets are loaded for H5P.

This is useful for adding custom styles or replacing existing ones.

This method can be overridden by other themes if the styles must be loaded from a different place than the "Raw initial SCSS" and "Raw SCSS" theme settings.

Parameters

stdClass[]	$styles	List of stylesheets that will be loaded
array	$libraries	Array of libraries indexed by the library's machineName
string	$embedtype	Possible values: div, iframe, external, editor

---

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

• h5p/classes/output/renderer.php