MDL-40062 mod_forum: subscription events
[moodle.git] / mod / forum / classes / event / subscribers_viewed.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 subscribers list viewed 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 subscribers list viewed event.
31  *
32  * @property-read array $other Extra information about the event.
33  *     - int forumid: The id of the forum which the subscriberslist has been viewed.
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 subscribers_viewed extends \core\event\base {
41     /**
42      * Init method.
43      *
44      * @return void
45      */
46     protected function init() {
47         $this->data['crud'] = 'r';
48         $this->data['edulevel'] = self::LEVEL_OTHER;
49     }
51     /**
52      * Returns description of what happened.
53      *
54      * @return string
55      */
56     public function get_description() {
57         return "The user {$this->userid} has viewed the subscribers list for forum {$this->other['forumid']}";
58     }
60     /**
61      * Return localised event name.
62      *
63      * @return string
64      */
65     public static function get_name() {
66         return get_string('eventsubscribersviewed', 'mod_forum');
67     }
69     /**
70      * Get URL related to the action
71      *
72      * @return \moodle_url
73      */
74     public function get_url() {
75         return new \moodle_url('/mod/forum/subscribers.php', array('id' => $this->other['forumid']));
76     }
78     /**
79      * Return the legacy event log data.
80      *
81      * @return array|null
82      */
83     protected function get_legacy_logdata() {
84         return array($this->courseid, 'forum', 'view subscribers', 'subscribers.php?id=' . $this->other['forumid'],
85             $this->other['forumid'], $this->contextinstanceid);
86     }
88     /**
89      * Custom validation.
90      *
91      * @throws \coding_exception
92      * @return void
93      */
94     protected function validate_data() {
95         parent::validate_data();
97         if (!isset($this->other['forumid'])) {
98             throw new \coding_exception('forumid must be set in other.');
99         }
101         if ($this->contextlevel != CONTEXT_MODULE) {
102             throw new \coding_exception('Context passed must be module context.');
103         }
104     }