MDL-36088 questions: Add new events
[moodle.git] / lib / classes / event / question_moved.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  * Question moved event.
19  *
20  * @package    core
21  * @copyright  2019 Stephen Bourget
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\event;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Question moved event class.
31  *
32  * @property-read array $other {
33  *      Extra information about the event.
34  *
35  *      - int newcategoryid: The ID of the new category of the question
36  *      - int oldcategoryid: The ID of the old category of the question
37  * }
38  *
39  * @package    core
40  * @since      Moodle 3.7
41  * @copyright  2019 Stephen Bourget
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class question_moved extends question_base {
46     /**
47      * Init method.
48      */
49     protected function init() {
50         parent::init();
51         $this->data['crud'] = 'u';
52     }
54     /**
55      * Returns localised general event name.
56      *
57      * @return string
58      */
59     public static function get_name() {
60         return get_string('eventquestionmoved', 'question');
61     }
63     /**
64      * Returns description of what happened.
65      *
66      * @return string
67      */
68     public function get_description() {
69         return "The user with id '$this->userid' moved the question with the id of '$this->objectid'" .
70                 " from the category with the id of '" . $this->other['oldcategoryid'] .
71                 "' to the category with the id of '" . $this->other['newcategoryid'] . "'.";
72     }
74     /**
75      * Returns relevant URL.
76      *
77      * @return \moodle_url
78      */
79     public function get_url() {
80         if ($this->courseid) {
81             $cat = $this->other['newcategoryid'] . ',' . $this->contextid;
82             if ($this->contextlevel == CONTEXT_MODULE) {
83                 return new \moodle_url('/question/edit.php',
84                         ['cmid' => $this->contextinstanceid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
85             }
86             return new \moodle_url('/question/edit.php',
87                     ['courseid' => $this->courseid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
88         }
89         // Lets try viewing from the frontpage for contexts above course.
90         return new \moodle_url('/question/category.php',
91                 ['courseid' => SITEID, 'edit' => $this->other['newcategoryid'], 'lastchanged' => $this->objectid]);
92     }
94     /**
95      * Custom validations.
96      *
97      * @throws \coding_exception
98      * @return void
99      */
100     protected function validate_data() {
102         if (!isset($this->other['oldcategoryid'])) {
103             throw new \coding_exception('The \'oldcategoryid\' must be set in \'other\'.');
104         }
105         if (!isset($this->other['newcategoryid'])) {
106             throw new \coding_exception('The \'newcategoryid\' must be set in \'other\'.');
107         }
108     }
110     /**
111      * Returns DB mappings used with backup / restore.
112      *
113      * @return array
114      */
115     public static function get_objectid_mapping() {
116         return ['db' => 'question', 'restore' => 'question'];
117     }
119     /**
120      * Used for maping events on restore
121      *
122      * @return array
123      */
124     public static function get_other_mapping() {
126         $othermapped = [];
127         $othermapped['newcategoryid'] = ['db' => 'question_categories', 'restore' => 'question_categories'];
128         $othermapped['oldcategoryid'] = ['db' => 'question_categories', 'restore' => 'question_categories'];
130         return $othermapped;
131     }