--- /dev/null
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * The mod_assign submission viewed event.
+ *
+ * @property-read array $other {
+ * Extra information about the event.
+ *
+ * - int assignid: the id of the assignment.
+ * }
+ *
+ * @package mod_assign
+ * @since Moodle 2.7
+ * @copyright 2014 Mark Nelson <markn@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_assign\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+class submission_viewed extends base {
+
+ /**
+ * Init method.
+ */
+ protected function init() {
+ $this->data['objecttable'] = 'assign_submission';
+ $this->data['crud'] = 'r';
+ $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+ }
+
+ /**
+ * Returns localised general event name.
+ *
+ * @return string
+ */
+ public static function get_name() {
+ return get_string('eventsubmissionviewed', 'mod_assign');
+ }
+
+ /**
+ * Returns description of what happened.
+ *
+ * @return string
+ */
+ public function get_description() {
+ return "The user with the id {$this->userid} viewed the submission for the user with the id {$this->relateduserid} for the
+ assignment with the id {$this->other['assignid']}.";
+ }
+
+ /**
+ * Custom validation.
+ *
+ * @throws \coding_exception
+ */
+ protected function validate_data() {
+ parent::validate_data();
+
+ if (!isset($this->relateduserid)) {
+ throw new \coding_exception('The \'relateduserid\' must be set.');
+ }
+
+ if (!isset($this->other['assignid'])) {
+ throw new \coding_exception('The \'assignid\' must be set in other.');
+ }
+ }
+}
$string['eventsubmissionstatusupdated'] = 'The status of the submission has been updated.';
$string['eventsubmissionunlocked'] = 'The submissions have been unlocked for a user.';
$string['eventsubmissionupdated'] = 'Submission updated.';
+$string['eventsubmissionviewed'] = 'Submission viewed.';
$string['eventworkflowstateupdated'] = 'The state of the workflow has been updated.';
$string['extensionduedate'] = 'Extension due date';
$string['extensionnotafterduedate'] = 'Extension date must be after the due date';
* @return string
*/
protected function view_plugin_content($pluginsubtype) {
- global $USER;
-
$o = '';
$submissionid = optional_param('sid', 0, PARAM_INT);
$this->get_return_action(),
$this->get_return_params()));
- $logmessage = get_string('viewsubmissionforuser', 'assign', $item->userid);
- $this->add_to_log('view submission', $logmessage);
+ // Trigger event for viewing a submission.
+ $logmessage = new lang_string('viewsubmissionforuser', 'assign', $item->userid);
+ $event = \mod_assign\event\submission_viewed::create(array(
+ 'objectid' => $item->id,
+ 'relateduserid' => $item->userid,
+ 'context' => $this->get_context(),
+ 'other' => array(
+ 'assignid' => $this->get_instance()->id
+ )
+ ));
+ $event->set_legacy_logdata('view submission', $logmessage);
+ $event->trigger();
} else {
$plugin = $this->get_feedback_plugin_by_type($plugintype);
if ($gradeid <= 0) {
$o .= $this->view_return_links();
$o .= $this->view_footer();
+
return $o;
}
* @return string
*/
protected function view_footer() {
- return $this->get_renderer()->render_footer();
+ // When viewing the footer during PHPUNIT tests a set_state error is thrown.
+ if (!PHPUNIT_TEST) {
+ return $this->get_renderer()->render_footer();
+ }
+
+ return '';
}
/**
$this->assertEventLegacyLogData($expected, $event);
$sink->close();
}
+
+ /**
+ * Test the submission_viewed event.
+ */
+ public function test_submission_viewed() {
+ global $PAGE;
+
+ $this->setUser($this->editingteachers[0]);
+
+ $assign = $this->create_instance();
+ $submission = $assign->get_user_submission($this->students[0]->id, true);
+
+ // We need to set the URL in order to view the submission.
+ $PAGE->set_url('/a_url');
+ // A hack - these variables are used by the view_plugin_content function to
+ // determine what we actually want to view - would usually be set in URL.
+ global $_POST;
+ $_POST['plugin'] = 'comments';
+ $_POST['sid'] = $submission->id;
+
+ // Trigger and capture the event.
+ $sink = $this->redirectEvents();
+ $assign->view('viewpluginassignsubmission');
+ $events = $sink->get_events();
+ $this->assertCount(1, $events);
+ $event = reset($events);
+
+ // Check that the event contains the expected values.
+ $this->assertInstanceOf('\mod_assign\event\submission_viewed', $event);
+ $this->assertEquals($assign->get_context(), $event->get_context());
+ $this->assertEquals($submission->id, $event->objectid);
+ $expected = array(
+ $assign->get_course()->id,
+ 'assign',
+ 'view submission',
+ 'view.php?id=' . $assign->get_course_module()->id,
+ get_string('viewsubmissionforuser', 'assign', $this->students[0]->id),
+ $assign->get_course_module()->id
+ );
+ $this->assertEventLegacyLogData($expected, $event);
+ $this->assertEventContextNotUsed($event);
+ }
}
