MDL-36088 questions: Add new events
[moodle.git] / lib / classes / event / question_category_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 category events.
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  * Base class for question category events
31  *
32  * @package    core
33  * @since      Moodle 3.7
34  * @copyright  2019 Stephen Bourget
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 abstract class question_category_base extends base {
39     /**
40      * Init method.
41      */
42     protected function init() {
43         $this->data['objecttable'] = 'question_categories';
44         $this->data['edulevel'] = self::LEVEL_TEACHING;
45     }
47     /**
48      * Returns relevant URL.
49      *
50      * @return \moodle_url
51      */
52     public function get_url() {
53         if ($this->courseid) {
54             $cat = $this->objectid . ',' . $this->contextid;
55             if ($this->contextlevel == CONTEXT_MODULE) {
56                 return new \moodle_url('/question/edit.php', ['cmid' => $this->contextinstanceid, 'cat' => $cat]);
57             }
58             return new \moodle_url('/question/edit.php', ['courseid' => $this->courseid, 'cat' => $cat]);
59         }
60         // Lets try viewing from the frontpage for contexts above course.
61         return new \moodle_url('/question/category.php', ['courseid' => SITEID, 'edit' => $this->objectid]);
62     }
64     /**
65      * Returns DB mappings used with backup / restore.
66      *
67      * @return array
68      */
69     public static function get_objectid_mapping() {
70         return ['db' => 'question_categories', 'restore' => 'question_categories'];
71     }
73     /**
74      * Create a event from question category object
75      *
76      * @param object $category
77      * @param object|null $context
78      * @return base
79      * @throws \coding_exception
80      */
81     public static function create_from_question_category_instance($category, $context = null) {
83         $params = ['objectid' => $category->id];
85         if (!empty($category->contextid)) {
86             $params['contextid'] = $category->contextid;
87         }
89         $params['context'] = $context;
91         $event = self::create($params);
92         return $event;
93     }
94 }