tool_installaddon_renderer Class Reference

Implements the plugin renderer. More...

Inheritance diagram for tool_installaddon_renderer:

Public Member Functions
	index_page ()
	Defines the index page layout.
	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.
	set_installer_instance (tool_installaddon_installer $installer)
	Sets the tool_installaddon_installer instance being used.
	zip_not_valid_plugin_package_page (moodle_url $continueurl)
	Inform the user that the ZIP is not a valid plugin package file.

Protected Member Functions
	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

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