message_output Class Reference

Inheritance diagram for message_output:

Public Member Functions
	send_message ($message)
	process_form ($form, &$preferences)
	load_data (&$preferences, $userid)
	config_form ($preferences)
	is_system_configured ()
	is_user_configured ($user=null)
	get_default_messaging_settings ()

---

Detailed Description

Base message output class

Definition at line 37 of file lib.php.

---

Member Function Documentation

config_form

(

$

preferences

)

[abstract]

Reimplemented in message_output_jabber, message_output_email, and message_output_popup.

get_default_messaging_settings

(

)

Returns:

int the Default message output settings for this output, for message providers that do not specify what the settings should be for this output in the messages.php file.

Reimplemented in message_output_email.

Definition at line 63 of file lib.php.

is_system_configured

(

)

Returns:

bool have all the necessary config settings been made that allow this plugin to be used.

Reimplemented in message_output_jabber.

Definition at line 46 of file lib.php.

is_user_configured

(

$

user = null

)

Parameters:

object

$user

the user object, defaults to $USER.

Returns:

bool has the user made all the necessary settings in their profile to allow this plugin to be used.

Reimplemented in message_output_jabber.

Definition at line 54 of file lib.php.

load_data	(	&$	preferences,
		$	userid
	)		[abstract]

Reimplemented in message_output_jabber, message_output_email, and message_output_popup.

process_form	(	$	form,
		&$	preferences
	)		[abstract]

Reimplemented in message_output_jabber, message_output_email, and message_output_popup.

send_message

(

$

message

)

[abstract]

Reimplemented in message_output_jabber, message_output_email, and message_output_popup.

---

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

• C:/xampp/htdocs/moodle/message/output/lib.php