Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
report_progress\output\renderer Class Reference
Inheritance diagram for report_progress\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_activity_order_select (\moodle_url $url, string $activityorder)
 Render activity order single select box.
 
 render_activity_section_select (\moodle_url $url, string $activitysection, array $sections)
 Render activity section single select box.
 
 render_download_buttons (\moodle_url $url)
 Render download buttons.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_groups_select (\moodle_url $url, stdClass $course)
 Render groups single select box.
 
 render_include_activity_select (\moodle_url $url, array $activitytypes, string $activityinclude)
 Render include activity single select box.
 
 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.
 

Member Function Documentation

◆ render_activity_order_select()

report_progress\output\renderer::render_activity_order_select ( \moodle_url $url,
string $activityorder )

Render activity order single select box.

Parameters
moodle_url$urlThe base url.
string$activityorderThe current selected option.
Return values
stringHTML
Exceptions
coding_exception

◆ render_activity_section_select()

report_progress\output\renderer::render_activity_section_select ( \moodle_url $url,
string $activitysection,
array $sections )

Render activity section single select box.

Parameters
moodle_url$urlThe base url.
string$activitysectionThe current selected section.
array$sectionsAn array containing all sections of the course
Return values
stringHTML
Exceptions
coding_exception

◆ render_download_buttons()

report_progress\output\renderer::render_download_buttons ( \moodle_url $url)

Render download buttons.

Parameters
moodle_url$urlThe base url.
Return values
stringHTML
Exceptions
coding_exception

◆ render_groups_select()

report_progress\output\renderer::render_groups_select ( \moodle_url $url,
stdClass $course )

Render groups single select box.

Parameters
moodle_url$urlThe base url.
stdClass$courseCurrent course.
Return values
stringHTML

◆ render_include_activity_select()

report_progress\output\renderer::render_include_activity_select ( \moodle_url $url,
array $activitytypes,
string $activityinclude )

Render include activity single select box.

Parameters
moodle_url$urlThe base url.
array$activitytypesThe activity type options.
string$activityincludeThe current selected option.
Return values
stringHTML
Exceptions
coding_exception

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