From 6c66b7f3b3dc5aae8c69a481df8a7932cb337717 Mon Sep 17 00:00:00 2001 From: Ankit Agarwal Date: Thu, 18 Jul 2013 15:17:06 +0800 Subject: [PATCH] MDL-40711 blogs: Replace blog_entry_deleted with events2 --- blog/locallib.php | 11 ++- blog/tests/bloglib_test.php | 18 ++++- lang/en/blog.php | 1 + lib/classes/event/blog_entry_deleted.php | 96 ++++++++++++++++++++++++ 4 files changed, 123 insertions(+), 3 deletions(-) create mode 100644 lib/classes/event/blog_entry_deleted.php diff --git a/blog/locallib.php b/blog/locallib.php index 70380609063..d743f70a280 100644 --- a/blog/locallib.php +++ b/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(); } /** diff --git a/blog/tests/bloglib_test.php b/blog/tests/bloglib_test.php index 6ed06586cf5..60e5858f764 100644 --- a/blog/tests/bloglib_test.php +++ b/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()); + } } diff --git a/lang/en/blog.php b/lang/en/blog.php index edf9dab207d..bf1c97c9cbb 100644 --- a/lang/en/blog.php +++ b/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'; diff --git a/lib/classes/event/blog_entry_deleted.php b/lib/classes/event/blog_entry_deleted.php new file mode 100644 index 00000000000..6cc3d64967a --- /dev/null +++ b/lib/classes/event/blog_entry_deleted.php @@ -0,0 +1,96 @@ +. + +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); + } +}