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

message Renderer More...

Inheritance diagram for core_message_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.
 
 manage_defaultmessageoutputs ($processors, $providers, $preferences)
 Display the interface to manage default message outputs.
 
 manage_messageoutput_settings ($allprocessors, $processors, $providers, $preferences)
 Display the interface to manage both message outputs and default message outputs.
 
 manage_messageoutputs ($processors)
 Display the interface to manage message outputs.
 
 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_user_message_preferences ($user)
 Display the interface for message preferences.
 
 render_user_notification_preferences ($user)
 Display the interface for notification preferences.
 
 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.
 

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

message Renderer

Class for rendering various message objects

@subpackage message

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

Member Function Documentation

◆ manage_defaultmessageoutputs()

core_message_renderer::manage_defaultmessageoutputs ( $processors,
$providers,
$preferences )

Display the interface to manage default message outputs.

Parameters
array$processorsarray of objects containing message processors
array$providersarray of objects containing message providers
stdClass$preferencesobject containing current preferences
Return values
stringThe text to render

◆ manage_messageoutput_settings()

core_message_renderer::manage_messageoutput_settings ( $allprocessors,
$processors,
$providers,
$preferences )

Display the interface to manage both message outputs and default message outputs.

Parameters
array$allprocessorsarray of objects containing all message processors
array$processorsarray of objects containing active message processors
array$providersarray of objects containing message providers
stdClass$preferencesobject containing current preferences
Return values
stringThe text to render

◆ manage_messageoutputs()

core_message_renderer::manage_messageoutputs ( $processors)

Display the interface to manage message outputs.

Parameters
array$processorsarray of objects containing message processors
Return values
stringThe text to render

◆ render_user_message_preferences()

core_message_renderer::render_user_message_preferences ( $user)

Display the interface for message preferences.

Parameters
object$userinstance of a user
Return values
stringThe text to render

◆ render_user_notification_preferences()

core_message_renderer::render_user_notification_preferences ( $user)

Display the interface for notification preferences.

Parameters
object$userinstance of a user
Return values
stringThe text to render

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