MDL-51312 core: added message_deleted event
authorMark Nelson <markn@moodle.com>
Tue, 22 Sep 2015 01:18:07 +0000 (18:18 -0700)
committerMark Nelson <markn@moodle.com>
Thu, 24 Sep 2015 22:13:42 +0000 (15:13 -0700)
lang/en/message.php
lib/classes/event/message_deleted.php [new file with mode: 0644]
message/lib.php

index 2acbcfa..a618353 100644 (file)
@@ -60,6 +60,7 @@ $string['eventmessagecontactadded'] = 'Message contact added';
 $string['eventmessagecontactblocked'] = 'Message contact blocked';
 $string['eventmessagecontactremoved'] = 'Message contact removed';
 $string['eventmessagecontactunblocked'] = 'Message contact unblocked';
+$string['eventmessagedeleted'] = 'Message deleted';
 $string['eventmessageviewed'] = 'Message viewed';
 $string['eventmessagesent'] = 'Message sent';
 $string['forced'] = 'Forced';
diff --git a/lib/classes/event/message_deleted.php b/lib/classes/event/message_deleted.php
new file mode 100644 (file)
index 0000000..5d3f71b
--- /dev/null
@@ -0,0 +1,145 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Message deleted event.
+ *
+ * @package    core
+ * @copyright  2015 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Message deleted event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ *
+ *      - string $messagetable: the table we marked the message as deleted from (message/message_read).
+ *      - int messageid: the id of the message.
+ *      - int useridfrom: the id of the user who received the message.
+ *      - int useridto: the id of the user who sent the message.
+ * }
+ *
+ * @package    core
+ * @since      Moodle 3.0
+ * @copyright  2015 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class message_deleted extends base {
+
+    /**
+     * Create event using ids.
+     *
+     * @param int $userfromid the user who the message was from.
+     * @param int $usertoid the user who the message was sent to.
+     * @param int $userdeleted the user who deleted it.
+     * @param string $messagetable the table we are marking the message as deleted in.
+     * @param int $messageid the id of the message that was deleted.
+     * @return message_deleted
+     */
+    public static function create_from_ids($userfromid, $usertoid, $userdeleted, $messagetable, $messageid) {
+        // Check who was deleting the message.
+        if ($userdeleted == $userfromid) {
+            $relateduserid = $usertoid;
+        } else {
+            $relateduserid = $userfromid;
+        }
+
+        // We set the userid to the user who deleted the message, nothing to do
+        // with whether or not they sent or received the message.
+        $event = self::create(array(
+            'userid' => $userdeleted,
+            'context' => \context_system::instance(),
+            'relateduserid' => $relateduserid,
+            'other' => array(
+                'messagetable' => $messagetable,
+                'messageid' => $messageid,
+                'useridfrom' => $userfromid,
+                'useridto' => $usertoid
+            )
+        ));
+
+        return $event;
+    }
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'u';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventmessagedeleted', 'message');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        // Check if the person who deleted the message received or sent it.
+        if ($this->userid == $this->other['useridto']) {
+            $str = 'from';
+        } else {
+            $str = 'to';
+        }
+
+        return "The user with id '$this->userid' deleted a message sent $str the user with id '$this->relateduserid'.";
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        parent::validate_data();
+
+        if (!isset($this->relateduserid)) {
+            throw new \coding_exception('The \'relateduserid\' must be set.');
+        }
+
+        if (!isset($this->other['messagetable'])) {
+            throw new \coding_exception('The \'messagetable\' value must be set in other.');
+        }
+
+        if (!isset($this->other['messageid'])) {
+            throw new \coding_exception('The \'messageid\' value must be set in other.');
+        }
+
+        if (!isset($this->other['useridfrom'])) {
+            throw new \coding_exception('The \'useridfrom\' value must be set in other.');
+        }
+
+        if (!isset($this->other['useridto'])) {
+            throw new \coding_exception('The \'useridto\' value must be set in other.');
+        }
+    }
+}
index f7a7676..09c834f 100644 (file)
@@ -1214,7 +1214,15 @@ function message_delete_message($message, $userid) {
     $updatemessage = new stdClass();
     $updatemessage->id = $message->id;
     $updatemessage->$coltimedeleted = time();
-    return $DB->update_record($messagetable, $updatemessage);
+    $success = $DB->update_record($messagetable, $updatemessage);
+
+    if ($success) {
+        // Trigger event for deleting a message.
+        \core\event\message_deleted::create_from_ids($message->useridfrom, $message->useridto,
+            $userid, $messagetable, $message->id)->trigger();
+    }
+
+    return $success;
 }
 
 /**