[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/admin/tool/installaddon/ -> renderer.php (summary)

Output rendering for the plugin.

Copyright: 2013 David Mudrak <[email protected]>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 398 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

tool_installaddon_renderer:: (16 methods):
  set_installer_instance()
  set_validator_instance()
  index_page()
  validation_page()
  remote_request_invalid_page()
  remote_request_alreadyinstalled_page()
  remote_request_confirm_page()
  remote_request_permcheck_page()
  remote_request_pluginfo_exception()
  installer_exception()
  index_page_heading()
  index_page_repository()
  index_page_upload()
  validation_page_heading()
  validation_page_messages()
  validation_page_continue()


Class: tool_installaddon_renderer  - X-Ref

Implements the plugin renderer

set_installer_instance(tool_installaddon_installer $installer)   X-Ref
Sets the tool_installaddon_installer instance being used.

param: tool_installaddon_installer $installer

set_validator_instance(tool_installaddon_validator $validator)   X-Ref
Sets the tool_installaddon_validator instance being used.

param: tool_installaddon_validator $validator

index_page()   X-Ref
Defines the index page layout

return: string

validation_page()   X-Ref
Defines the validation results page layout

return: string

remote_request_invalid_page(moodle_url $continueurl)   X-Ref
Inform the user about invalid remote installation request.

param: moodle_url $continueurl
return: string

remote_request_alreadyinstalled_page(stdClass $data, moodle_url $continueurl)   X-Ref
Inform the user that such plugin is already installed

param: stdClass $data decoded request data
param: moodle_url $continueurl
return: string

remote_request_confirm_page(stdClass $data, moodle_url $continueurl, moodle_url $cancelurl)   X-Ref
Let the user confirm the remote installation request.

param: stdClass $data decoded request data
param: moodle_url $continueurl
param: moodle_url $cancelurl
return: string

remote_request_permcheck_page(stdClass $data, $plugintypepath, moodle_url $continueurl, moodle_url $cancelurl)   X-Ref
Inform the user that the target plugin type location is not writable.

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

remote_request_pluginfo_exception(stdClass $data, tool_installaddon_pluginfo_exception $e, moodle_url $continueurl)   X-Ref
Inform the user about pluginfo service call exception

This implementation does not actually use the passed exception. Custom renderers might want to
display additional data obtained via {@link get_exception_info()}. Also note, this method is called
in non-debugging mode only. If debugging is allowed at the site, default exception handler is triggered.

param: stdClass $data decoded request data
param: tool_installaddon_pluginfo_exception $e thrown exception
param: moodle_url $continueurl
return: string

installer_exception(tool_installaddon_installer_exception $e, moodle_url $continueurl)   X-Ref
Inform the user about the installer exception

This implementation does not actually use the passed exception. Custom renderers might want to
display additional data obtained via {@link get_exception_info()}. Also note, this method is called
in non-debugging mode only. If debugging is allowed at the site, default exception handler is triggered.

param: tool_installaddon_installer_exception $e thrown exception
param: moodle_url $continueurl
return: string

index_page_heading()   X-Ref
Renders the index page heading

return: string

index_page_repository()   X-Ref
Renders the widget for browsing the add-on repository

return: string

index_page_upload()   X-Ref
Renders the widget for uploading the add-on ZIP package

return: string

validation_page_heading()   X-Ref
Renders the page title and the overall validation verdict

return: string

validation_page_messages()   X-Ref
Renders validation log messages.

return: string

validation_page_continue()   X-Ref
Renders widgets to continue from the validation results page

return: string



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1