Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
tool_analytics\output\renderer Class Reference

Renderer class. More...

Inheritance diagram for tool_analytics\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_analytics_disabled ()
 Renders an analytics disabled notification.
 
 render_evaluate_results ($results, $logs=array())
 Web interface evaluate results.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_get_predictions_results ($trainresults=false, $trainlogs=array(), $predictresults=false, $predictlogs=array())
 Web interface training & prediction results.
 
 render_table (\table_sql $table)
 Renders a table.
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the 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_insights_report (\tool_analytics\output\insights_report $insightsreport)
 Defer to template.
 
 render_invalid_analysables (\tool_analytics\output\invalid_analysables $invalidanalysables)
 Defer to template.
 
 render_models_list (\tool_analytics\output\models_list $modelslist)
 Defer to template.
 

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

Renderer class.

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

Member Function Documentation

◆ render_analytics_disabled()

tool_analytics\output\renderer::render_analytics_disabled ( )

Renders an analytics disabled notification.

Return values
stringHTML

◆ render_evaluate_results()

tool_analytics\output\renderer::render_evaluate_results ( $results,
$logs = array() )

Web interface evaluate results.

Parameters
stdClass[]$results
string[]$logs
Return values
stringHTML

◆ render_get_predictions_results()

tool_analytics\output\renderer::render_get_predictions_results ( $trainresults = false,
$trainlogs = array(),
$predictresults = false,
$predictlogs = array() )

Web interface training & prediction results.

Parameters
stdClass | false$trainresults
string[]$trainlogs
stdClass | false$predictresults
string[]$predictlogs
Return values
stringHTML

◆ render_insights_report()

tool_analytics\output\renderer::render_insights_report ( \tool_analytics\output\insights_report $insightsreport)
protected

Defer to template.

Parameters
tool_analytics\output\insights_report$insightsreport
Return values
stringHTML

◆ render_invalid_analysables()

tool_analytics\output\renderer::render_invalid_analysables ( \tool_analytics\output\invalid_analysables $invalidanalysables)
protected

Defer to template.

Parameters
tool_analytics\output\invalid_analysables$invalidanalysables
Return values
stringHTML

◆ render_models_list()

tool_analytics\output\renderer::render_models_list ( \tool_analytics\output\models_list $modelslist)
protected

Defer to template.

Parameters
tool_analytics\output\models_list$modelslist
Return values
stringHTML

◆ render_table()

tool_analytics\output\renderer::render_table ( \table_sql $table)

Renders a table.

Parameters
table_sql$table
Return values
stringHTML

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