MDL-40062 mod_forum: discussion events
[moodle.git] / mod / forum / classes / event / discussion_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/>.
17 /**
18  * The mod_forum discussion deleted event.
19  *
20  * @package    mod_forum
21  * @copyright  2014 Dan Poltawski <dan@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_forum\event;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * The mod_forum discussion deleted event.
31  *
32  * @property-read array $other Extra information about the event.
33  *     -int forumid: The id of the forum the discussion is in
34  *
35  * @package    mod_forum
36  * @copyright  2014 Dan Poltawski <dan@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class discussion_deleted extends \core\event\base {
41     /**
42      * Init method.
43      *
44      * @return void
45      */
46     protected function init() {
47         $this->data['crud'] = 'd';
48         $this->data['edulevel'] = self::LEVEL_OTHER;
49         $this->data['objecttable'] = 'forum_discussions';
50     }
52     /**
53      * Returns description of what happened.
54      *
55      * @return string
56      */
57     public function get_description() {
58         return "The user {$this->userid} has deleted the forum discussion {$this->objectid} ".
59             "in forum {$this->other['forumid']}";
60     }
62     /**
63      * Return localised event name.
64      *
65      * @return string
66      */
67     public static function get_name() {
68         return get_string('eventdiscussiondeleted', 'mod_forum');
69     }
71     /**
72      * Get URL related to the action
73      *
74      * @return \moodle_url
75      */
76     public function get_url() {
77         return new \moodle_url('/mod/forum/view.php', array('id' => $this->contextinstanceid));
78     }
80     /**
81      * Return the legacy event log data.
82      *
83      * @return array|null
84      */
85     protected function get_legacy_logdata() {
86         return array($this->courseid, 'forum', 'delete discussion', 'view.php?id=' . $this->contextinstanceid,
87             $this->other['forumid'], $this->contextinstanceid);
88     }
90     /**
91      * Custom validation.
92      *
93      * @throws \coding_exception
94      * @return void
95      */
96     protected function validate_data() {
97         parent::validate_data();
98         if (!isset($this->other['forumid'])) {
99             throw new \coding_exception('forumid must be set in $other.');
100         }
102         if ($this->contextlevel != CONTEXT_MODULE) {
103             throw new \coding_exception('Context passed must be module context.');
104         }
106         if (!isset($this->objectid)) {
107             throw new \coding_exception('objectid must be set to the discussionid.');
108         }
109     }