 |
Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
|
Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
Implements the plugin renderer. More...
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 () | |
| 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. | |
Implements the plugin renderer.
| tool_installaddon_renderer::index_page | ( | ) |
Defines the index page layout.
| string |
|
protected |
Renders the index page heading.
| string |
|
protected |
Renders the widget for browsing the add-on repository.
| string |
|
protected |
Renders the widget for uploading the add-on ZIP package.
| string |
| tool_installaddon_renderer::remote_request_alreadyinstalled_page | ( | stdClass | $data, |
| moodle_url | $continueurl ) |
Inform the user that such plugin is already installed.
| stdClass | $data | decoded request data |
| moodle_url | $continueurl |
| string |
| tool_installaddon_renderer::remote_request_confirm_page | ( | stdClass | $data, |
| moodle_url | $continueurl, | ||
| moodle_url | $cancelurl ) |
Let the user confirm the remote installation request.
| stdClass | $data | decoded request data |
| moodle_url | $continueurl | |
| moodle_url | $cancelurl |
| string |
| tool_installaddon_renderer::remote_request_invalid_page | ( | moodle_url | $continueurl | ) |
Inform the user about invalid remote installation request.
| moodle_url | $continueurl |
| string |
| tool_installaddon_renderer::remote_request_non_installable_page | ( | stdClass | $data, |
| moodle_url | $continueurl ) |
Inform the user that the requested remote plugin is not installable.
| stdClass | $data | decoded request data with ->reason property added |
| moodle_url | $continueurl |
| string |
| 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.
| 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 |
| string |
| tool_installaddon_renderer::set_installer_instance | ( | tool_installaddon_installer | $installer | ) |
Sets the tool_installaddon_installer instance being used.
| coding_exception | if the installer has been already set |
| tool_installaddon_installer | $installer |
| 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.
| moodle_url | $continueurl |
| string |
1.11.0