MDL-41599 events: Set relateduserid instead of userid in blog events
[moodle.git] / lib / classes / event / blog_entry_deleted.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Event for when a new blog entry is deleted.
18  *
19  * @package    core_blog
20  * @copyright  2013 Ankit Agarwal
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
23 namespace core\event;
25 /**
26  * class blog_entry_deleted
27  *
28  * Event for when a new blog entry is deleted.
29  *
30  * @package    core_blog
31  * @copyright  2013 Ankit Agarwal
32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
35 class blog_entry_deleted extends \core\event\base {
37     /** @var  \blog_entry A reference to the active blog_entry object. */
38     protected $customobject;
40     /**
41      * Set basic event properties.
42      */
43     protected function init() {
44         $this->context = \context_system::instance();
45         $this->data['objecttable'] = 'post';
46         $this->data['crud'] = 'd';
47         $this->data['level'] = self::LEVEL_PARTICIPATING;
48     }
50     /**
51      * Returns localised general event name.
52      *
53      * @return string
54      */
55     public static function get_name() {
56         return get_string("evententrydeleted", "core_blog");
57     }
59     /**
60      * Set custom data of the event.
61      *
62      * @param \blog_entry $data A reference to the active blog_entry object.
63      */
64     public function set_custom_data($data) {
65         $this->customobject = $data;
66     }
68     /**
69      * Returns non-localised description of what happened.
70      *
71      * @return string
72      */
73     public function get_description() {
74         return "Blog entry ".$this->other['record']['subject']." was deleted by user with id ".$this->userid;
75     }
77     /**
78      * Does this event replace legacy event?
79      *
80      * @return string legacy event name
81      */
82     public static function get_legacy_eventname() {
83         return 'blog_entry_deleted';
84     }
86     /**
87      * Legacy event data if get_legacy_eventname() is not empty.
88      *
89      * @return \blog_entry
90      */
91     protected function get_legacy_eventdata() {
92         return $this->customobject;
93     }
95     /**
96      * replace add_to_log() statement.
97      *
98      * @return array of parameters to be passed to legacy add_to_log() function.
99      */
100     protected function get_legacy_logdata() {
101         return array (SITEID, 'blog', 'delete', 'index.php?userid=' . $this->relateduserid, 'deleted blog entry with entry id# '.
102                 $this->objectid);
103     }