tool_installaddon_renderer Class Reference

Implements the plugin renderer. More...

Inheritance diagram for tool_installaddon_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.
	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.
	index_page ()
	Defines the index page layout.
	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.
	remote_request_alreadyinstalled_page (stdClass $data, moodle_url $continueurl)
	Inform the user that such plugin is already installed.
	remote_request_confirm_page (stdClass $data, moodle_url $continueurl, moodle_url $cancelurl)
	Let the user confirm the remote installation request.
	remote_request_invalid_page (moodle_url $continueurl)
	Inform the user about invalid remote installation request.
	remote_request_non_installable_page (stdClass $data, moodle_url $continueurl)
	Inform the user that the requested remote plugin is not installable.
	remote_request_permcheck_page (stdClass $data, $plugintypepath, moodle_url $continueurl, moodle_url $cancelurl)
	Inform the user that the target plugin type location is not writable.
	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.
	set_installer_instance (tool_installaddon_installer $installer)
	Sets the tool_installaddon_installer instance being used.
	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.
	zip_not_valid_plugin_package_page (moodle_url $continueurl)
	Inform the user that the ZIP is not a valid plugin package file.

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.
	index_page_heading ()
	Renders the index page heading.
	index_page_repository ()
	Renders the widget for browsing the add-on repository.
	index_page_upload ()
	Renders the widget for uploading the add-on ZIP package.

Protected Attributes
tool_installaddon_installer	$installer = null
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.

Detailed Description

Implements the plugin renderer.

Copyright

2013 David Mudrak david.nosp@m.@moo.nosp@m.dle.c.nosp@m.om

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

__call()

plugin_renderer_base::__call ( $method, $arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

add_action_handler()

renderer_base::add_action_handler ( component_action $action, $id = null )

inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters

component_action	$action
string	$id

Return values

string

id of element, either original submitted or random new if not supplied

get_compact_logo_url()

renderer_base::get_compact_logo_url ( $maxwidth = 300, $maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

get_logo_url()

renderer_base::get_logo_url ( $maxwidth = null, $maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since

2.9

Return values

Mustache_Engine

has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean

true if the header has been printed.

image_url()

renderer_base::image_url ( $imagename, $component = 'moodle' )

inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

index_page()

tool_installaddon_renderer::index_page

(

)

Defines the index page layout.

Return values

string

index_page_heading()

tool_installaddon_renderer::index_page_heading ( )

protected

Renders the index page heading.

Return values

string

index_page_repository()

tool_installaddon_renderer::index_page_repository ( )

protected

Renders the widget for browsing the add-on repository.

Return values

string

index_page_upload()

tool_installaddon_renderer::index_page_upload ( )

protected

Renders the widget for uploading the add-on ZIP package.

Return values

string

pix_url()

renderer_base::pix_url ( $imagename, $component = 'moodle' )

inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated

since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed

$classes

Space-separated string or array of classes

Return values

string

HTML class attribute value

remote_request_alreadyinstalled_page()

tool_installaddon_renderer::remote_request_alreadyinstalled_page	(	stdClass	$data,
		moodle_url	$continueurl )

Inform the user that such plugin is already installed.

Parameters

stdClass	$data	decoded request data
moodle_url	$continueurl

Return values

string

remote_request_confirm_page()

tool_installaddon_renderer::remote_request_confirm_page	(	stdClass	$data,
		moodle_url	$continueurl,
		moodle_url	$cancelurl )

Let the user confirm the remote installation request.

Parameters

stdClass	$data	decoded request data
moodle_url	$continueurl
moodle_url	$cancelurl

Return values

string

remote_request_invalid_page()

tool_installaddon_renderer::remote_request_invalid_page

(

moodle_url

$continueurl

)

Inform the user about invalid remote installation request.

Parameters

moodle_url

$continueurl

Return values

string

remote_request_non_installable_page()

tool_installaddon_renderer::remote_request_non_installable_page	(	stdClass	$data,
		moodle_url	$continueurl )

Inform the user that the requested remote plugin is not installable.

Parameters

stdClass	$data	decoded request data with ->reason property added
moodle_url	$continueurl

Return values

string

remote_request_permcheck_page()

tool_installaddon_renderer::remote_request_permcheck_page	(	stdClass	$data,
			$plugintypepath,
		moodle_url	$continueurl,
		moodle_url	$cancelurl )

Inform the user that the target plugin type location is not writable.

Parameters

stdClass	$data	decoded request data
string	$plugintypepath	full path to the plugin type location
moodle_url	$continueurl	to repeat the write permission check
moodle_url	$cancelurl	to cancel the installation

Return values

string

render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable

$widget

instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

render_from_template()

renderer_base::render_from_template ( $templatename, $context )

inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since

2.9

Parameters

array | stdClass

$context

Context containing data for the template.

Return values

string|boolean

set_installer_instance()

tool_installaddon_renderer::set_installer_instance

(

tool_installaddon_installer

$installer

)

Sets the tool_installaddon_installer instance being used.

Exceptions

coding_exception

if the installer has been already set

Parameters

tool_installaddon_installer

$installer

should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated

since Moodle 4.0

Todo

final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int

$headinglevel

The heading level we want to check against.

Return values

bool

should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

zip_not_valid_plugin_package_page()

tool_installaddon_renderer::zip_not_valid_plugin_package_page

(

moodle_url

$continueurl

)

Inform the user that the ZIP is not a valid plugin package file.

Parameters

moodle_url

$continueurl

Return values

string

Member Data Documentation

$output

renderer_base core_renderer plugin_renderer_base::$output

protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer

---

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

• admin/tool/installaddon/renderer.php