MDL-36088 questions: Add new events
[moodle.git] / lib / classes / event / questions_imported.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  * Questions imported 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 category imported event class.
31  *
32  * @package    core
33  * @since      Moodle 3.2
34  * @copyright  2016 Stephen Bourget
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class questions_imported extends question_base {
39     /**
40      * Init method.
41      */
42     protected function init() {
43         $this->data['crud'] = 'c';
44         $this->data['edulevel'] = self::LEVEL_TEACHING;
45     }
47     /**
48      * Returns localised general event name.
49      *
50      * @return string
51      */
52     public static function get_name() {
53         return get_string('eventquestionsimported', 'question');
54     }
56     /**
57      * Returns description of what happened.
58      *
59      * @return string
60      */
61     public function get_description() {
62         return "The user with id '$this->userid' imported questions in '". $this->other['format'].
63                 "' format into the category with id '".$this->other['categoryid']."'.";
64     }
66     /**
67      * Returns relevant URL.
68      *
69      * @return \moodle_url
70      */
71     public function get_url() {
72         if ($this->courseid) {
73             $cat = $this->other['categoryid'] . ',' . $this->contextid;
74             if ($this->contextlevel == CONTEXT_MODULE) {
75                 return new \moodle_url('/question/edit.php', array('cmid' => $this->contextinstanceid, 'cat' => $cat));
76             }
77             return new \moodle_url('/question/edit.php', array('courseid' => $this->courseid, 'cat' => $cat));
78         }
79         return new \moodle_url('/question/category.php', array('courseid' => SITEID, 'edit' => $this->other['categoryid']));
80     }
82     /**
83      * Custom validations.
84      *
85      * @throws \coding_exception
86      * @return void
87      */
88     protected function validate_data() {
89         parent::validate_data();
91         if (!isset($this->other['categoryid'])) {
92             throw new \coding_exception('The \'categoryid\' must be set in \'other\'.');
93         }
94         if (!isset($this->other['format'])) {
95             throw new \coding_exception('The \'format\' must be set in \'other\'.');
96         }
97     }
99     /**
100      * Returns DB mappings used with backup / restore.
101      * This is needed to override the function in question_base
102      *
103      * @return array
104      */
105     public static function get_objectid_mapping() {
106         // No mappings.
107         return array();
108     }