6f1ea7a2d9c282497ba8d208c5753a0f4457d31e
[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  2016 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 categoryid: The ID of the category where the question resides
36  * }
37  *
38  * @package    core
39  * @since      Moodle 3.6
40  * @copyright  2016 Stephen Bourget
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class question_moved extends base {
45     /**
46      * Init method.
47      */
48     protected function init() {
49         $this->data['objecttable'] = 'question';
50         $this->data['crud'] = 'u';
51         $this->data['edulevel'] = self::LEVEL_TEACHING;
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', array('cmid' => $this->contextinstanceid, 'cat' => $cat, 'lastchanged' => $this->objectid));
84             }
85             return new \moodle_url('/question/edit.php', array('courseid' => $this->courseid, 'cat' => $cat, 'lastchanged' => $this->objectid));
86         }
87         // Lets try viewing from the frontpage for contexts above course.
88         return new \moodle_url('/question/category.php', array('courseid' => SITEID, 'edit' => $this->other['newcategoryid'], 'lastchanged' => $this->objectid));
89     }
91     /**
92      * Custom validations.
93      *
94      * @throws \coding_exception
95      * @return void
96      */
97     protected function validate_data() {
98         parent::validate_data();
100         if (!isset($this->other['oldcategoryid'])) {
101             throw new \coding_exception('The \'oldcategoryid\' must be set in \'other\'.');
102         }
103         if (!isset($this->other['newcategoryid'])) {
104             throw new \coding_exception('The \'newcategoryid\' must be set in \'other\'.');
105         }
106     }
108     /**
109      * Returns DB mappings used with backup / restore.
110      *
111      * @return array
112      */
113     public static function get_objectid_mapping() {
114         return array('db' => 'question', 'restore' => 'question');
115     }
117     /**
118      * Used for maping events on restore
119      *
120      * @return array
121      */
122     public static function get_other_mapping() {
124         $othermapped = array();
125         $othermapped['newcategoryid'] = array('db' => 'question_categories', 'restore' => 'question_categories');
126         $othermapped['oldcategoryid'] = array('db' => 'question_categories', 'restore' => 'question_categories');
128         return $othermapped;
129     }