MDL-36088 questions: Add new events
[moodle.git] / lib / classes / event / question_moved.php
CommitLineData
93e435b9
SB
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/**
18 * Question moved event.
19 *
20 * @package core
4ca60a56 21 * @copyright 2019 Stephen Bourget
93e435b9
SB
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Question moved event class.
31 *
32 * @property-read array $other {
33 * Extra information about the event.
34 *
4ca60a56
V
35 * - int newcategoryid: The ID of the new category of the question
36 * - int oldcategoryid: The ID of the old category of the question
93e435b9
SB
37 * }
38 *
39 * @package core
4ca60a56
V
40 * @since Moodle 3.7
41 * @copyright 2019 Stephen Bourget
93e435b9
SB
42 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43 */
4ca60a56 44class question_moved extends question_base {
93e435b9
SB
45
46 /**
47 * Init method.
48 */
49 protected function init() {
4ca60a56 50 parent::init();
93e435b9 51 $this->data['crud'] = 'u';
93e435b9
SB
52 }
53
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 }
62
63 /**
64 * Returns description of what happened.
65 *
66 * @return string
67 */
68 public function get_description() {
4ca60a56
V
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'] . "'.";
93e435b9
SB
72 }
73
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) {
4ca60a56
V
83 return new \moodle_url('/question/edit.php',
84 ['cmid' => $this->contextinstanceid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
93e435b9 85 }
4ca60a56
V
86 return new \moodle_url('/question/edit.php',
87 ['courseid' => $this->courseid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
93e435b9
SB
88 }
89 // Lets try viewing from the frontpage for contexts above course.
4ca60a56
V
90 return new \moodle_url('/question/category.php',
91 ['courseid' => SITEID, 'edit' => $this->other['newcategoryid'], 'lastchanged' => $this->objectid]);
93e435b9
SB
92 }
93
94 /**
95 * Custom validations.
96 *
97 * @throws \coding_exception
98 * @return void
99 */
100 protected function validate_data() {
93e435b9
SB
101
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 }
109
110 /**
111 * Returns DB mappings used with backup / restore.
112 *
113 * @return array
114 */
115 public static function get_objectid_mapping() {
4ca60a56 116 return ['db' => 'question', 'restore' => 'question'];
93e435b9
SB
117 }
118
119 /**
120 * Used for maping events on restore
121 *
122 * @return array
123 */
124 public static function get_other_mapping() {
125
4ca60a56
V
126 $othermapped = [];
127 $othermapped['newcategoryid'] = ['db' => 'question_categories', 'restore' => 'question_categories'];
128 $othermapped['oldcategoryid'] = ['db' => 'question_categories', 'restore' => 'question_categories'];
93e435b9
SB
129
130 return $othermapped;
131 }
132}