MDL-40063 mod_quiz: replaced 'view summary' add_to_log call with an event
[moodle.git] / mod / quiz / classes / event / attempt_summary_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  * Attempt summary viewed event.
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  */
32 namespace mod_quiz\event;
34 defined('MOODLE_INTERNAL') || die();
36 class attempt_summary_viewed extends \core\event\base {
38     /**
39      * Init method.
40      *
41      * @return void
42      */
43     protected function init() {
44         $this->data['objecttable'] = 'quiz_attempts';
45         $this->data['crud'] = 'r';
46         $this->data['edulevel'] = self::LEVEL_TEACHING;
47     }
49     /**
50      * Return localised event name.
51      *
52      * @return string
53      */
54     public static function get_name() {
55         return get_string('eventattemptsummaryviewed', 'mod_quiz');
56     }
58     /**
59      * Returns description of what happened.
60      *
61      * @return string
62      */
63     public function get_description() {
64         return 'The summary for the quiz attempt with the id of ' . $this->objectid . ' belonging to a user with the id ' .
65             $this->relateduserid . ' was viewed by a user with the id ' . $this->userid;
66     }
68     /**
69      * Get URL related to the action.
70      *
71      * @return \moodle_url
72      */
73     public function get_url() {
74         return new \moodle_url('/mod/quiz/summary.php', array('attempt' => $this->objectid));
75     }
77     /**
78      * Return the legacy event log data.
79      *
80      * @return array
81      */
82     protected function get_legacy_logdata() {
83         return array($this->courseid, 'quiz', 'view summary', 'summary.php?attempt=' . $this->objectid,
84             $this->other['quizid'], $this->contextinstanceid);
85     }
87     /**
88      * Custom validation.
89      *
90      * @throws \coding_exception
91      * @return void
92      */
93     protected function validate_data() {
94         parent::validate_data();
96         if (!isset($this->relateduserid)) {
97             throw new \coding_exception('The \'relateduserid\' must be set.');
98         }
100         if (!isset($this->other['quizid'])) {
101             throw new \coding_exception('The \'quizid\' must be set in other.');
102         }
103     }