--- /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/>.
+
+/**
+ * Attempt summary viewed event.
+ *
+ * @property-read array $other {
+ * Extra information about event.
+ *
+ * - int quizid: the id of the quiz.
+ * }
+ *
+ * @package mod_quiz
+ * @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_quiz\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+class attempt_summary_viewed extends \core\event\base {
+
+ /**
+ * Init method.
+ *
+ * @return void
+ */
+ protected function init() {
+ $this->data['objecttable'] = 'quiz_attempts';
+ $this->data['crud'] = 'r';
+ $this->data['edulevel'] = self::LEVEL_TEACHING;
+ }
+
+ /**
+ * Return localised event name.
+ *
+ * @return string
+ */
+ public static function get_name() {
+ return get_string('eventattemptsummaryviewed', 'mod_quiz');
+ }
+
+ /**
+ * Returns description of what happened.
+ *
+ * @return string
+ */
+ public function get_description() {
+ return 'The summary for the quiz attempt with the id of ' . $this->objectid . ' belonging to a user with the id ' .
+ $this->relateduserid . ' was viewed by a user with the id ' . $this->userid;
+ }
+
+ /**
+ * Get URL related to the action.
+ *
+ * @return \moodle_url
+ */
+ public function get_url() {
+ return new \moodle_url('/mod/quiz/summary.php', array('attempt' => $this->objectid));
+ }
+
+ /**
+ * Return the legacy event log data.
+ *
+ * @return array
+ */
+ protected function get_legacy_logdata() {
+ return array($this->courseid, 'quiz', 'view summary', 'summary.php?attempt=' . $this->objectid,
+ $this->other['quizid'], $this->contextinstanceid);
+ }
+
+ /**
+ * Custom validation.
+ *
+ * @throws \coding_exception
+ * @return void
+ */
+ protected function validate_data() {
+ parent::validate_data();
+
+ if (!isset($this->relateduserid)) {
+ throw new \coding_exception('The \'relateduserid\' must be set.');
+ }
+
+ if (!isset($this->other['quizid'])) {
+ throw new \coding_exception('The \'quizid\' must be set in other.');
+ }
+ }
+}
$string['essayquestions'] = 'Questions';
$string['eventattemptdeleted'] = 'Quiz attempt deleted';
$string['eventattemptreviewed'] = 'Quiz attempt reviewed';
+$string['eventattemptsummaryviewed'] = 'Quiz attempt summary viewed';
$string['eventeditpageviewed'] = 'Quiz edit page viewed';
$string['eventquizattemptabandoned'] = 'Quiz attempt abandoned';
$string['eventquizattempttimelimitexceeded'] = 'Quiz attempt time limit exceeded';
redirect($attemptobj->review_url());
}
-// Log this page view.
-add_to_log($attemptobj->get_courseid(), 'quiz', 'view summary',
- 'summary.php?attempt=' . $attemptobj->get_attemptid(),
- $attemptobj->get_quizid(), $attemptobj->get_cmid());
-
// Arrange for the navigation to be displayed.
if (empty($attemptobj->get_quiz()->showblocks)) {
$PAGE->blocks->show_only_fake_blocks();
// Display the page.
echo $output->summary_page($attemptobj, $displayoptions);
+
+// Log this page view.
+$params = array(
+ 'objectid' => $attemptobj->get_attemptid(),
+ 'relateduserid' => $attemptobj->get_userid(),
+ 'courseid' => $attemptobj->get_courseid(),
+ 'context' => context_module::instance($attemptobj->get_cmid()),
+ 'other' => array(
+ 'quizid' => $attemptobj->get_quizid()
+ )
+);
+$event = \mod_quiz\event\attempt_summary_viewed::create($params);
+$event->add_record_snapshot('quiz_attempts', $attemptobj->get_attempt());
+$event->trigger();
$this->assertEventLegacyLogData($expected, $event);
$this->assertEventContextNotUsed($event);
}
+
+ /**
+ * Test the attempt summary viewed event.
+ *
+ * There is no external API for viewing the attempt summary, so the unit test will simply
+ * create and trigger the event and ensure the event data is returned as expected.
+ */
+ public function test_attempt_summary_viewed() {
+ $this->resetAfterTest();
+
+ $this->setAdminUser();
+ $course = $this->getDataGenerator()->create_course();
+ $quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id));
+
+ $params = array(
+ 'objectid' => 1,
+ 'relateduserid' => 2,
+ 'courseid' => $course->id,
+ 'context' => context_module::instance($quiz->cmid),
+ 'other' => array(
+ 'quizid' => $quiz->id
+ )
+ );
+ $event = \mod_quiz\event\attempt_summary_viewed::create($params);
+
+ // Trigger and capture the event.
+ $sink = $this->redirectEvents();
+ $event->trigger();
+ $events = $sink->get_events();
+ $event = reset($events);
+
+ // Check that the event data is valid.
+ $this->assertInstanceOf('\mod_quiz\event\attempt_summary_viewed', $event);
+ $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context());
+ $expected = array($course->id, 'quiz', 'view summary', 'summary.php?attempt=1', $quiz->id, $quiz->cmid);
+ $this->assertEventLegacyLogData($expected, $event);
+ $this->assertEventContextNotUsed($event);
+ }
}
