Inheritance diagram for mod_folder_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.

	display_folder (stdClass $folder)
	Returns html to display the content of mod_folder (Description, folder files and optionally Edit button)

	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.

	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 ()

	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.

	htmllize_tree ($tree, $dir)
	Internal function - creates htmls structure suitable for YUI tree.

	renderable_tree_elements (folder_tree $tree, array $dir)
	Internal function - Creates elements structure suitable for mod_folder/folder template.

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

◆ display_folder()

mod_folder_renderer::display_folder ( stdClass $folder )

Returns html to display the content of mod_folder (Description, folder files and optionally Edit button)

Parameters

stdClass $folder record from 'folder' table (please note it may not contain fields 'revision' and 'timemodified')

Return values

string

mod_folder_renderer::htmllize_tree	(		$tree,
			$dir )

protected

Internal function - creates htmls structure suitable for YUI tree.

mod_folder_renderer::renderable_tree_elements	(	folder_tree	$tree,
		array	$dir )

protected

Internal function - Creates elements structure suitable for mod_folder/folder template.

Parameters

folder_tree	$tree	The folder tree to work with.
array	$dir	The subdir and files structure to convert into a tree.

Return values

array The structure to be rendered by mod_folder/folder template.

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