MDL-41101 mod_assign: replaced 'view submission grading table' add_to_log call with...
[moodle.git] / mod / assign / classes / event / grading_table_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  * The mod_assign grading table viewed event.
19  *
20  * @property-read array $other {
21  *      Extra information about event.
22  *
23  *      - int assignid: the id of the assignment.
24  * }
25  *
26  * @package    mod_assign
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_assign\event;
34 defined('MOODLE_INTERNAL') || die();
36 class grading_table_viewed extends base {
38     /**
39      * Init method.
40      */
41     protected function init() {
42         $this->data['crud'] = 'r';
43         $this->data['edulevel'] = self::LEVEL_TEACHING;
44     }
46     /**
47      * Returns localised general event name.
48      *
49      * @return string
50      */
51     public static function get_name() {
52         return get_string('eventgradingtableviewed', 'mod_assign');
53     }
55     /**
56      * Returns description of what happened.
57      *
58      * @return string
59      */
60     public function get_description() {
61         return "The user with the id {$this->userid} viewed the grading table for the assignment with the id {$this->other['assignid']}.";
62     }
64     /**
65      * Custom validation.
66      *
67      * @throws \coding_exception
68      */
69     protected function validate_data() {
70         parent::validate_data();
72         if (!isset($this->other['assignid'])) {
73             throw new \coding_exception('The \'assignid\' must be set in other.');
74         }
75     }
76 }