|
| __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.
|
|
| pix_url ($imagename, $component='moodle') |
| Return the direct URL for an image from the pix folder.
|
|
| render (renderable $widget) |
| Renders the provided widget and returns the HTML to display it.
|
|
| render_core_availability_multiple_messages () |
|
| render_from_template ($templatename, $context) |
| Renders a template by name with the given context.
|
|
| should_display_main_logo () |
|
| should_display_navbar_logo () |
| Whether we should display the logo in the navbar.
|
|
|
static | prepare_classes ($classes) |
| Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
|
|
|
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.
|
|
◆ __call()
core\output\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
-
◆ add_action_handler()
core\output\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 {
- See also
- 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()
core\output\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
-
◆ get_logo_url()
core\output\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
-
◆ get_mustache()
core\output\renderer_base::get_mustache |
( |
| ) |
|
|
protectedinherited |
Return an instance of the mustache class.
- Since
- 2.9
- Return values
-
◆ get_page()
core\output\renderer_base::get_page |
( |
| ) |
|
|
inherited |
Returns the moodle page object.
- Return values
-
◆ has_started()
core\output\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()
core\output\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
-
◆ pix_url()
core\output\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
-
◆ prepare_classes()
static core\output\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 |
◆ render()
core\output\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
-
Reimplemented from core\output\renderer_base.
◆ render_core_availability_multiple_messages()
core_availability_renderer::render_core_availability_multiple_messages |
( |
| ) |
|
◆ render_from_template()
core\output\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
-
string | $templatename | The template to render |
array | stdClass | $context | Context containing data for the template. |
- Return values
-
◆ should_display_main_logo()
core\output\renderer_base::should_display_main_logo |
( |
| ) |
|
|
inherited |
◆ should_display_navbar_logo()
core\output\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
-
◆ $output
renderer_base core_renderer core\output\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 {
- See also
- core_renderer}
The documentation for this class was generated from the following file:
- availability/renderer.php