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.
	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.
	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

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

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

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

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

---

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

• admin/tool/installaddon/renderer.php