3690a4cdf191bb06a2477ef9d71950968dbca17e
[moodle.git] / lib / classes / event / question_base.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  * Base class for question events.
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  * Base class for question events.
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 question_base extends base {
39     /**
40      * Init method.
41      */
42     protected function init() {
43         $this->data['edulevel'] = self::LEVEL_TEACHING;
44     }
46     /**
47      * Returns relevant URL.
48      *
49      * @return \moodle_url
50      */
51     public function get_url() {
52         if ($this->courseid) {
53             $cat = $this->other['categoryid'] . ',' . $this->contextid;
54             if ($this->contextlevel == CONTEXT_MODULE) {
55                 return new \moodle_url('/question/edit.php', array('cmid' => $this->contextinstanceid, 'cat' => $cat, 'lastchanged' => $this->objectid));
56             }
57             return new \moodle_url('/question/edit.php', array('courseid' => $this->courseid, 'cat' => $cat, 'lastchanged' => $this->objectid));
58         }
59         // Lets try viewing from the frontpage for contexts above course.
60         return new \moodle_url('/question/category.php', array('courseid' => SITEID, 'edit' => $this->other['categoryid'], 'lastchanged' => $this->objectid));
61     }
63     /**
64      * Custom validations.
65      *
66      * @throws \coding_exception
67      * @return void
68      */
69     protected function validate_data() {
70         parent::validate_data();
72         if (!isset($this->other['categoryid'])) {
73             throw new \coding_exception('The \'categoryid\' must be set in \'other\'.');
74         }
75     }
77     /**
78      * Returns DB mappings used with backup / restore.
79      *
80      * @return array
81      */
82     public static function get_objectid_mapping() {
83         return array('db' => 'question', 'restore' => 'question');
84     }
86     /**
87      * Used for maping events on restore
88      *
89      * @return array
90      */
91     public static function get_other_mapping() {
93         $othermapped = array();
94         $othermapped['categoryid'] = array('db' => 'question_categories', 'restore' => 'question_categories');
95         return $othermapped;
96     }
97 }