Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_reportbuilder\output\renderer Class Reference
Inheritance diagram for core_reportbuilder\output\renderer:
plugin_renderer_base renderer_base

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.
 
 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_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_fullpage_editor_header (report $report)
 Renders full page editor header.
 
 render_new_report_button ()
 Renders the New report button.
 
 should_display_main_logo ()
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 

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.
 
 render_custom_report (custom_report $report)
 Render a custom report.
 
 render_custom_report_table (custom_report_table $table)
 Render a custom report table.
 
 render_custom_report_table_view (custom_report_table_view $table)
 Render a custom report table (view only mode)
 
 render_system_report (system_report $report)
 Render a system report.
 
 render_system_report_table (system_report_table $table)
 Render a system report table.
 

Protected Attributes

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.
 

Member Function Documentation

◆ render_custom_report()

core_reportbuilder\output\renderer::render_custom_report ( custom_report $report)
protected

Render a custom report.

Parameters
custom_report$report
Return values
string

◆ render_custom_report_table()

core_reportbuilder\output\renderer::render_custom_report_table ( custom_report_table $table)
protected

Render a custom report table.

Parameters
custom_report_table$table
Return values
string

◆ render_custom_report_table_view()

core_reportbuilder\output\renderer::render_custom_report_table_view ( custom_report_table_view $table)
protected

Render a custom report table (view only mode)

Parameters
custom_report_table_view$table
Return values
string

◆ render_fullpage_editor_header()

core_reportbuilder\output\renderer::render_fullpage_editor_header ( report $report)

Renders full page editor header.

Parameters
report$report
Return values
string

◆ render_new_report_button()

core_reportbuilder\output\renderer::render_new_report_button ( )

Renders the New report button.

Return values
string

◆ render_system_report()

core_reportbuilder\output\renderer::render_system_report ( system_report $report)
protected

Render a system report.

Parameters
system_report$report
Return values
string

◆ render_system_report_table()

core_reportbuilder\output\renderer::render_system_report_table ( system_report_table $table)
protected

Render a system report table.

Parameters
system_report_table$table
Return values
string

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