MDL-40711 blogs: Replace blog_entry_deleted with events2

blog/locallib.php

@@ -316,11 +316,18 @@ class blog_entry implements renderable {
         $this->delete_attachments();
         $this->remove_associations();
 
+        // Get record to pass onto the event.
+        $record = $DB->get_record('post', array('id' => $this->id));
         $DB->delete_records('post', array('id' => $this->id));
         tag_set('post', $this->id, array());
 
-        add_to_log(SITEID, 'blog', 'delete', 'index.php?userid='. $this->userid, 'deleted blog entry with entry id# '. $this->id);
-        events_trigger('blog_entry_deleted', $this);
+        $event = \core\event\blog_entry_deleted::create(array('objectid' => $this->id,
+                                                            'userid'   => $this->userid,
+                                                            'other'   => array("record" => (array)$record)
+                                                      ));
+        $event->add_record_snapshot("post", $record);
+        $event->set_custom_data($this);
+        $event->trigger();
     }
 
     /**

blog/tests/bloglib_test.php

@@ -155,7 +155,7 @@ class core_bloglib_testcase extends advanced_testcase {
      * Test various blog related events.
      */
     public function test_blog_entry_events() {
-        global $USER;
+        global $USER, $DB;
 
         $this->setAdminUser();
         $this->resetAfterTest();
@@ -178,5 +178,21 @@ class core_bloglib_testcase extends advanced_testcase {
         $this->assertEquals($blog->id, $event->objectid);
         $this->assertEquals($USER->id, $event->userid);
         $this->assertEquals("post", $event->objecttable);
+
+        // Delete a blog entry.
+        $record = $DB->get_record('post', array('id' => $blog->id));
+        $blog->delete();
+        $events = $sink->get_events();
+        $event = array_pop($events);
+
+        // Validate event data.
+        $this->assertInstanceOf('\core\event\blog_entry_deleted', $event);
+        $this->assertEquals(context_system::instance()->id, $event->contextid);
+        $this->assertEquals($blog->id, $event->objectid);
+        $this->assertEquals($USER->id, $event->userid);
+        $this->assertEquals("post", $event->objecttable);
+        $this->assertEquals($record, $event->get_record_snapshot("post", $blog->id));
+        $this->assertSame('blog_entry_deleted', $event->get_legacy_eventname());
+
     }
 }

lang/en/blog.php

@@ -88,6 +88,7 @@ $string['entrysaved'] = 'Your entry has been saved';
 $string['entrytitle'] = 'Entry title';
 $string['entryupdated'] = 'Blog entry updated';
 $string['evententryadded'] = 'Blog entry added';
+$string['evententrydeleted'] = 'Blog entry deleted';
 $string['externalblogcrontime'] = 'External blog cron schedule';
 $string['externalblogdeleteconfirm'] = 'Unregister this external blog?';
 $string['externalblogdeleted'] = 'External blog unregistered';

lib/classes/event/blog_entry_deleted.php

@@ -0,0 +1,96 @@
+<?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/>.
+
+namespace core\event;
+
+/**
+ * Event for when a new blog entry is deleted.
+ *
+ * @package    core_blog
+ * @copyright  2013 Ankit Agarwal
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+class blog_entry_deleted extends \core\event\base {
+
+    /** @var  \blog_entry A reference to the active blog_entry object. */
+    protected $customobject;
+
+    protected function init() {
+        $this->context = \context_system::instance();
+        $this->data['objecttable'] = 'post';
+        $this->data['crud'] = 'd';
+        // TODO: MDL-37658 set level.
+        $this->data['level'] = 50;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return \lang_string
+     */
+    public static function get_name() {
+        return new \lang_string("evententrydeleted", "core_blog");
+    }
+
+    /**
+     * Set custom data of the event.
+     *
+     * @param \blog_entry $data A reference to the active blog_entry object.
+     */
+    public function set_custom_data($data) {
+        $this->customobject = $data;
+    }
+
+    /**
+     * Returns localised description of what happened.
+     *
+     * @return \lang_string
+     */
+    public function get_description() {
+        $a = new \stdClass();
+        $a->subject = $this->other['record']['subject'];
+        $a->userid = $this->userid;
+        return new \lang_string("evententrydeleteddesc", "core_blog", $a);
+    }
+
+    /**
+     * Does this event replace legacy event?
+     *
+     * @return string legacy event name
+     */
+    public static function get_legacy_eventname() {
+        return 'blog_entry_deleted';
+    }
+
+    /**
+     * Legacy event data if get_legacy_eventname() is not empty.
+     *
+     * @return \blog_entry
+     */
+    protected function get_legacy_eventdata() {
+        return $this->customobject;
+    }
+
+    /**
+     * replace add_to_log() statement.
+     *
+     * @return array of parameters to be passed to legacy add_to_log() function.
+     */
+    protected function get_legacy_logdata() {
+        return array (SITEID, 'blog', 'delete', 'index.php?userid='.$this->userid, 'deleted blog entry with entry id# '. $this->objectid);
+    }
+}