MDL-40062 mod_forum: subscription events
[moodle.git] / mod / forum / classes / event / subscription_created.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 subscription created 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 subscription created event.
31  *
32  * @property-read array $other Extra information about the event.
33  *     - int forumid: The id of the forum which has been subscribed to.
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 subscription_created extends \core\event\base {
40     /**
41      * Init method.
42      *
43      * @return void
44      */
45     protected function init() {
46         $this->data['crud'] = 'c';
47         $this->data['edulevel'] = self::LEVEL_OTHER;
48     }
50     /**
51      * Returns description of what happened.
52      *
53      * @return string
54      */
55     public function get_description() {
56         return "The user {$this->relateduserid} was subscribed to the forum {$this->other['forumid']}";
57     }
59     /**
60      * Return localised event name.
61      *
62      * @return string
63      */
64     public static function get_name() {
65         return get_string('eventsubscriptioncreated', 'mod_forum');
66     }
68     /**
69      * Get URL related to the action
70      *
71      * @return \moodle_url
72      */
73     public function get_url() {
74         return new \moodle_url('/mod/forum/view.php', array('id' => $this->other['forumid']));
75     }
77     /**
78      * Return the legacy event log data.
79      *
80      * @return array|null
81      */
82     protected function get_legacy_logdata() {
83         return array($this->courseid, 'forum', 'subscribe', 'view.php?f=' . $this->other['forumid'],
84             $this->other['forumid'], $this->contextinstanceid);
85     }
87     /**
88      * Custom validation.
89      *
90      * @throws \coding_exception
91      * @return void
92      */
93     protected function validate_data() {
94         parent::validate_data();
95         if (!isset($this->relateduserid)) {
96             throw new \coding_exception('relateduserid must be set.');
97         }
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         }
105     }