core_message_renderer Class Reference

message Renderer More...

Inheritance diagram for core_message_renderer:

Public Member Functions
	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.
	render_user_message_preferences ($user)
	Display the interface for message preferences.
	render_user_notification_preferences ($user)
	Display the interface for notification preferences.

Detailed Description

message Renderer

Class for rendering various message objects

@subpackage message

Copyright

2011 Lancaster University Network Services Limited

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	$processors	array of objects containing message processors
array	$providers	array of objects containing message providers
stdClass	$preferences	object containing current preferences

Return values

string

The 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	$allprocessors	array of objects containing all message processors
array	$processors	array of objects containing active message processors
array	$providers	array of objects containing message providers
stdClass	$preferences	object containing current preferences

Return values

string

The text to render

manage_messageoutputs()

core_message_renderer::manage_messageoutputs

(

$processors

)

Display the interface to manage message outputs.

Parameters

array

$processors

array of objects containing message processors

Return values

string

The text to render

render_user_message_preferences()

core_message_renderer::render_user_message_preferences

(

$user

)

Display the interface for message preferences.

Parameters

object

$user

instance of a user

Return values

string

The text to render

render_user_notification_preferences()

core_message_renderer::render_user_notification_preferences

(

$user

)

Display the interface for notification preferences.

Parameters

object

$user

instance of a user

Return values

string

The text to render

---

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

• message/renderer.php