mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 08:55:15 +02:00
Code Issues Projects Releases Wiki Activity

MDL-48212 messages: support the new class in message apis

Browse Source
This commit is contained in:
Ankit Agarwal 2015-01-22 12:40:57 +05:30
parent 53a842e6a9
commit c6f45ef884
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/classes/message/manager.php
View File

@ -50,13 +50,19 @@ class manager {
*
* NOTE: to be used from message_send() only.
*
* @param \stdClass $eventdata fully prepared event data for processors
* @param \stdClass|\core\message\message $eventdata fully prepared event data for processors
* @param \stdClass $savemessage the message saved in 'message' table
* @param array $processorlist list of processors for target user
* @return int $messageid the id from 'message' or 'message_read' table (false is not returned)
*/
public static function send_message(\stdClass $eventdata, \stdClass $savemessage, array $processorlist) {
public static function send_message($eventdata, \stdClass $savemessage, array $processorlist) {
global $CFG;
if (!($eventdata instanceof \stdClass) && !($eventdata instanceof message)) {
// Not a valid object.
throw new \coding_exception('Message should be of type stdClass or \core\message\message');
}
require_once($CFG->dirroot.'/message/lib.php'); // This is most probably already included from messagelib.php file.
if (empty($processorlist)) {
@ -85,12 +91,13 @@ class manager {
/**
* Send message to message processors.
*
* @param \stdClass $eventdata
* @param \stdClass|\core\message\message $eventdata
* @param \stdClass $savemessage
* @param array $processorlist
* @return int $messageid
*/
protected static function send_message_to_processors(\stdClass $eventdata, \stdClass $savemessage, array $processorlist) {
protected static function send_message_to_processors($eventdata, \stdClass $savemessage, array
$processorlist) {
global $CFG, $DB;
// We cannot communicate with external systems in DB transactions,
@ -114,7 +121,9 @@ class manager {
$failed = false;
foreach ($processorlist as $procname) {
if (!$processors[$procname]->object->send_message($eventdata)) {
// Let new messaging class add custom content based on the processor.
$proceventdata = ($eventdata instanceof message) ? $eventdata->get_eventobject_for_processor($procname) : $eventdata;
if (!$processors[$procname]->object->send_message($proceventdata)) {
debugging('Error calling message processor ' . $procname);
$failed = true;
// Previously the $messageid = false here was overridden

2
lib/messagelib.php
View File

@ -51,7 +51,7 @@ require_once(dirname(dirname(__FILE__)) . '/message/lib.php');
* earlier versions did not do it consistently either.
*
* @category message
* @param stdClass $eventdata information about the message (component, userfrom, userto, ...)
* @param stdClass|\core\message\message $eventdata information about the message (component, userfrom, userto, ...)
* @return mixed the integer ID of the new message or false if there was a problem with submitted data
*/
function message_send($eventdata) {