MDL-40063 mod_quiz: replaced 'editquestions' add_to_log call with an event
[moodle.git] / mod / quiz / classes / event / edit_page_viewed.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  * Edit page viewed event class.
19  *
20  * @property-read array $other {
21  *      Extra information about event.
22  *
23  *      - int quizid: the id of the quiz.
24  * }
25  *
26  * @package    mod_quiz
27  * @since      Moodle 2.7
28  * @copyright  2014 Mark Nelson <markn@moodle.com>
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
31 namespace mod_quiz\event;
33 defined('MOODLE_INTERNAL') || die();
35 class edit_page_viewed extends \core\event\base {
37     /**
38      * Init method.
39      */
40     protected function init() {
41         $this->data['crud'] = 'r';
42         $this->data['edulevel'] = self::LEVEL_TEACHING;
43     }
45     /**
46      * Returns localised general event name.
47      *
48      * @return string
49      */
50     public static function get_name() {
51         return get_string('eventeditpageviewed', 'mod_quiz');
52     }
54     /**
55      * Returns description of what happened.
56      *
57      * @return string
58      */
59     public function get_description() {
60         return 'The edit quiz page belonging to the quiz with the id ' . $this->other['quizid'] . ' was viewed by the user
61             with the id ' . $this->userid;
62     }
64     /**
65      * Returns relevant URL.
66      *
67      * @return \moodle_url
68      */
69     public function get_url() {
70         return new \moodle_url('/mod/quiz/edit.php', array('cmid' => $this->contextinstanceid));
71     }
73     /**
74      * Return the legacy event log data.
75      *
76      * @return array
77      */
78     protected function get_legacy_logdata() {
79         return array($this->courseid, 'quiz', 'editquestions', 'view.php?id=' . $this->contextinstanceid,
80             $this->other['quizid'], $this->contextinstanceid);
81     }
83     /**
84      * Custom validation.
85      *
86      * @throws \coding_exception
87      * @return void
88      */
89     protected function validate_data() {
90         parent::validate_data();
92         if (!isset($this->other['quizid'])) {
93             throw new \coding_exception('The \'quizid\' must be set in other.');
94         }
95     }
96 }