Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
forumreport_summary_renderer Class Reference

Renderer for the forum summary report. More...

Inheritance diagram for forumreport_summary_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_filters_form (stdClass $course, array $cms, moodle_url $actionurl, array $filters=[])
 Render the filters available for the forum summary report.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_summary_table (summary_table $table)
 Render the summary report 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.
 

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 for the forum summary report.

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

Member Function Documentation

◆ render_filters_form()

forumreport_summary_renderer::render_filters_form ( stdClass $course,
array $cms,
moodle_url $actionurl,
array $filters = [] )

Render the filters available for the forum summary report.

Parameters
stdClass$courseThe course object.
array$cmsArray of course module objects.
moodle_url$actionurlThe form action URL.
array$filtersOptional array of currently applied filter values.
Return values
stringThe filter form HTML.

◆ render_summary_table()

forumreport_summary_renderer::render_summary_table ( summary_table $table)

Render the summary report table.

Parameters
summary_table$tableThe summary table to be rendered.
Return values
stringThe report table HTML.

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