Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
report_loglive_renderer Class Reference

Report log renderer's for printing reports. More...

Inheritance diagram for report_loglive_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.
 
 reader_selector (report_loglive_renderable $reportloglive)
 Prints/return reader selector.
 
 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_report_loglive_renderable (report_loglive_renderable $reportloglive)
 This method should never be manually called, it should only be called by process.
 
 should_display_main_logo ()
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 
 toggle_liveupdate_button (report_loglive_renderable $reportloglive)
 Prints a button to update/resume live updates.
 

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_report_loglive (report_loglive_renderable $reportloglive)
 Return html to render the loglive page.
 
 render_table (report_loglive_table_log $table, $perpage)
 Get the html for the 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.
 

Detailed Description

Report log renderer's for printing reports.

Since
Moodle 2.7
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ reader_selector()

report_loglive_renderer::reader_selector ( report_loglive_renderable $reportloglive)

Prints/return reader selector.

Parameters
report_loglive_renderable$reportloglivelog report.
Return values
stringReturns rendered widget

◆ render_report_loglive()

report_loglive_renderer::render_report_loglive ( report_loglive_renderable $reportloglive)
protected

Return html to render the loglive page.

Parameters
report_loglive_renderable$reportlogliveobject of report_log.
Return values
stringhtml used to render the page;

◆ render_report_loglive_renderable()

report_loglive_renderer::render_report_loglive_renderable ( report_loglive_renderable $reportloglive)

This method should never be manually called, it should only be called by process.

Please call the render method instead.

Deprecated
since 2.8, to be removed in 2.9
Parameters
report_loglive_renderable$reportloglive
Return values
string

◆ render_table()

report_loglive_renderer::render_table ( report_loglive_table_log $table,
$perpage )
protected

Get the html for the table.

Parameters
report_loglive_table_log$tabletable object.
int$perpageentries to display perpage.
Return values
stringtable html

◆ toggle_liveupdate_button()

report_loglive_renderer::toggle_liveupdate_button ( report_loglive_renderable $reportloglive)

Prints a button to update/resume live updates.

Parameters
report_loglive_renderable$reportloglivelog report.
Return values
stringReturns rendered widget

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