Moodle  2.2.1
http://www.collinsharper.com
message_output_jabber Class Reference
Inheritance diagram for message_output_jabber:
Collaboration diagram for message_output_jabber:

Public Member Functions

 send_message ($eventdata)
 config_form ($preferences)
 process_form ($form, &$preferences)
 load_data (&$preferences, $userid)
 is_system_configured ()
 is_user_configured ($user=null)

Detailed Description

Definition at line 37 of file message_output_jabber.php.


Member Function Documentation

config_form ( preferences)

Creates necessary fields in the messaging config form.

Parameters:
object$mformpreferences form class

Reimplemented from message_output.

Definition at line 95 of file message_output_jabber.php.

Here is the call graph for this function:

Tests whether the Jabber settings have been configured

Returns:
boolean true if Jabber is configured

Reimplemented from message_output.

Definition at line 129 of file message_output_jabber.php.

Here is the caller graph for this function:

is_user_configured ( user = null)

Tests whether the Jabber settings have been configured on user level

Parameters:
object$userthe 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 from message_output.

Definition at line 140 of file message_output_jabber.php.

Here is the call graph for this function:

load_data ( &$  preferences,
userid 
)

Loads the config data from database to put on the form (initial load)

Parameters:
array$preferencespreferences array
int$useridthe user id

Reimplemented from message_output.

Definition at line 121 of file message_output_jabber.php.

Here is the call graph for this function:

process_form ( form,
&$  preferences 
)

Parses the form submitted data and saves it into preferences array.

Parameters:
object$mformpreferences form class
array$preferencespreferences array

Reimplemented from message_output.

Definition at line 110 of file message_output_jabber.php.

send_message ( eventdata)

Processes the message (sends using jabber).

Parameters:
object$eventdatathe event data submitted by the message sender plus $eventdata->savedmessageid
Returns:
true if ok, false if error

Reimplemented from message_output.

Definition at line 44 of file message_output_jabber.php.

Here is the call graph for this function:


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations