MDL-45890 Blog: add additional events
[moodle.git] / lib / classes / event / blog_association_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 associated with a context.
18  *
19  * @package    core
20  * @copyright  2016 Stephen Bourget
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
23 namespace core\event;
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Class for event to be triggered when a new blog entry is deleted with a context.
29  *
30  * @property-read array $other {
31  *      Extra information about event.
32  *
33  *      - int blogid: id of blog.
34  * }
35  *
36  * @package    core
37  * @since      Moodle 3.2
38  * @copyright  2016 Stephen Bourget
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class blog_association_deleted extends base {
43     /**
44      * Set basic properties for the event.
45      */
46     protected function init() {
47         $this->context = \context_system::instance();
48         $this->data['objecttable'] = 'blog_association';
49         $this->data['crud'] = 'd';
50         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
51     }
53     /**
54      * Returns localised general event name.
55      *
56      * @return string
57      */
58     public static function get_name() {
59         return get_string('eventblogassociationdeleted', 'core_blog');
60     }
62     /**
63      * Returns non-localised event description with id's for admin use only.
64      *
65      * @return string
66      */
67     public function get_description() {
68         return "The user with id '$this->userid' removed the associations from the blog entry with id "
69             . "'{$this->other['blogid']}'.";
70     }
72     /**
73      * Returns relevant URL.
74      * @return \moodle_url
75      */
76     public function get_url() {
77         return new \moodle_url('/blog/index.php', array('entryid' => $this->other['blogid']));
78     }
80     /**
81      * Custom validations.
82      *
83      * @throws \coding_exception when validation fails.
84      * @return void
85      */
86     protected function validate_data() {
87         parent::validate_data();
89         if (!isset($this->relateduserid)) {
90             throw new \coding_exception('The \'relateduserid\' must be set.');
91         }
93         if (!isset($this->other['blogid'])) {
94             throw new \coding_exception('The \'blogid\' value must be set in other.');
95         }
96     }
98     /**
99      * Used for restore of objectid.
100      *
101      * @return array
102      */
103     public static function get_objectid_mapping() {
104         // Blogs are not included in backups, so no mapping required for restore.
105         return array('db' => 'blog_association', 'restore' => base::NOT_MAPPED);
106     }
108     /**
109      * Used for mappings of "other" data on restore.
110      *
111      * @return array
112      */
113     public static function get_other_mapping() {
114         // Blogs are not included in backups, so no mapping required for restore.
115         $othermapped = array();
116         $othermapped['blogid'] = array('db' => 'post', 'restore' => base::NOT_MAPPED);
118         return $othermapped;
119     }