Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/message/output/jabber/ -> message_output_jabber.php (source)

[Source view]

Differences Between: [Versions 39 and 311]

Jabber message processor to send messages by jabber

Copyright: 2008 Luis Rodrigues
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 180 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

message_output_jabber:: (6 methods):
  send_message()
  config_form()
  process_form()
  load_data()
  is_system_configured()
  is_user_configured()


Class: message_output_jabber  - X-Ref

The jabber message processor

send_message($eventdata)   X-Ref
Processes the message and sends a notification via jabber

param: stdClass $eventdata the event data submitted by the message sender plus $eventdata->savedmessageid
return: true if ok, false if error

config_form($preferences)   X-Ref
Creates necessary fields in the messaging config form.

param: array $preferences An array of user preferences

process_form($form, &$preferences)   X-Ref
Parses the submitted form data and saves it into preferences array.

param: stdClass $form preferences form class
param: array $preferences preferences array

load_data(&$preferences, $userid)   X-Ref
Loads the config data from database to put on the form during initial form display

param: array $preferences preferences array
param: int $userid the user id

is_system_configured()   X-Ref
Tests whether the Jabber settings have been configured

return: boolean true if Jabber is configured

is_user_configured($user = null)   X-Ref
Tests whether the Jabber settings have been configured on user level

param: object $user the user object, defaults to $USER.
return: bool has the user made all the necessary settings