MDL-45629 mod_assign: removed use of '$this->objectid' in the submission_status_viewe...
[moodle.git] / mod / assign / classes / event / submission_status_viewed.php
CommitLineData
cf2d7bfb
MN
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/>.
16
0e5deb20
PS
17/**
18 * The mod_assign submission status viewed event.
19 *
20 * @package mod_assign
21 * @copyright 2014 Mark Nelson <markn@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace mod_assign\event;
26
27defined('MOODLE_INTERNAL') || die();
28
cf2d7bfb 29/**
02a5a4b2 30 * The mod_assign submission status viewed event class.
cf2d7bfb
MN
31 *
32 * @property-read array $other {
33 * Extra information about event.
34 *
35 * - int assignid: the id of the assignment.
36 * }
37 *
38 * @package mod_assign
39 * @since Moodle 2.7
40 * @copyright 2014 Mark Nelson <markn@moodle.com>
41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 */
cf2d7bfb 43class submission_status_viewed extends base {
1b90858f
PS
44 /**
45 * Flag for prevention of direct create() call.
46 * @var bool
47 */
48 protected static $preventcreatecall = true;
49
50 /**
51 * Create instance of event.
52 *
1b90858f
PS
53 * @param \assign $assign
54 * @return submission_status_viewed
55 */
56 public static function create_from_assign(\assign $assign) {
57 $data = array(
58 'context' => $assign->get_context(),
59 'other' => array(
60 'assignid' => $assign->get_instance()->id,
61 ),
62 );
63 self::$preventcreatecall = false;
64 /** @var submission_status_viewed $event */
65 $event = self::create($data);
66 self::$preventcreatecall = true;
bf5b4413 67 $event->set_assign($assign);
1b90858f
PS
68 return $event;
69 }
70
cf2d7bfb
MN
71 /**
72 * Init method.
73 *
74 * @return void
75 */
76 protected function init() {
77 $this->data['crud'] = 'r';
78 $this->data['edulevel'] = self::LEVEL_OTHER;
79 }
80
81 /**
82 * Return localised event name.
83 *
84 * @return string
85 */
86 public static function get_name() {
87 return get_string('eventsubmissionstatusviewed', 'mod_assign');
88 }
89
90 /**
91 * Returns description of what happened.
92 *
93 * @return string
94 */
95 public function get_description() {
9d4b3d42
MN
96 return "The user with id '$this->userid' has viewed the submission status page for the assignment with the " .
97 "course module id '$this->contextinstanceid'.";
cf2d7bfb
MN
98 }
99
1b90858f
PS
100 /**
101 * Return legacy data for add_to_log().
102 *
103 * @return array
104 */
105 protected function get_legacy_logdata() {
106 $this->set_legacy_logdata('view', get_string('viewownsubmissionstatus', 'assign'));
107 return parent::get_legacy_logdata();
108 }
109
cf2d7bfb
MN
110 /**
111 * Custom validation.
112 *
113 * @throws \coding_exception
1b90858f 114 * @return void
cf2d7bfb
MN
115 */
116 protected function validate_data() {
1b90858f
PS
117 if (self::$preventcreatecall) {
118 throw new \coding_exception('cannot call submission_status_viewed::create() directly, use submission_status_viewed::create_from_assign() instead.');
119 }
120
cf2d7bfb
MN
121 parent::validate_data();
122
123 if (!isset($this->other['assignid'])) {
124 throw new \coding_exception('The \'assignid\' must be set in other.');
125 }
126 }
127}