diff --git a/mod/quiz/attempt.php b/mod/quiz/attempt.php index d7a5b1be91d..181c9bc80c4 100644 --- a/mod/quiz/attempt.php +++ b/mod/quiz/attempt.php @@ -95,9 +95,18 @@ if ($autosaveperiod) { } // Log this page view. -add_to_log($attemptobj->get_courseid(), 'quiz', 'continue attempt', - 'review.php?attempt=' . $attemptobj->get_attemptid(), - $attemptobj->get_quizid(), $attemptobj->get_cmid()); +$params = array( + 'objectid' => $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_viewed::create($params); +$event->add_record_snapshot('quiz_attempts', $attemptobj->get_attempt()); +$event->trigger(); // Get the list of questions needed by this page. $slots = $attemptobj->get_slots($page); diff --git a/mod/quiz/classes/event/attempt_viewed.php b/mod/quiz/classes/event/attempt_viewed.php new file mode 100644 index 00000000000..a9620ffbe78 --- /dev/null +++ b/mod/quiz/classes/event/attempt_viewed.php @@ -0,0 +1,101 @@ +. + +/** + * Attempt viewed event class. + * + * @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 + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_quiz\event; + +defined('MOODLE_INTERNAL') || die(); + +class attempt_viewed extends \core\event\base { + + /** + * Init method. + */ + protected function init() { + $this->data['objecttable'] = 'quiz_attempts'; + $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('eventattemptviewed', 'mod_quiz'); + } + + /** + * Returns description of what happened. + * + * @return string + */ + public function get_description() { + return 'A quiz attempt with the id of ' . $this->objectid . ' belonging to the quiz with the id ' . $this->other['quizid'] . + ' was viewed by the user with the id ' . $this->relateduserid; + } + + /** + * Returns relevant URL. + * + * @return \moodle_url + */ + public function get_url() { + return new \moodle_url('/mod/quiz/review.php', array('attempt' => $this->objectid)); + } + + /** + * Return the legacy event log data. + * + * @return array + */ + protected function get_legacy_logdata() { + return array($this->courseid, 'quiz', 'continue attempt', 'review.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.'); + } + } +} diff --git a/mod/quiz/lang/en/quiz.php b/mod/quiz/lang/en/quiz.php index 583250584ff..035affeba47 100644 --- a/mod/quiz/lang/en/quiz.php +++ b/mod/quiz/lang/en/quiz.php @@ -308,6 +308,7 @@ $string['essayquestions'] = 'Questions'; $string['eventattemptdeleted'] = 'Quiz attempt deleted'; $string['eventattemptreviewed'] = 'Quiz attempt reviewed'; $string['eventattemptsummaryviewed'] = 'Quiz attempt summary viewed'; +$string['eventattemptviewed'] = 'Quiz attempt viewed'; $string['eventeditpageviewed'] = 'Quiz edit page viewed'; $string['eventoverridedeleted'] = 'Quiz override deleted'; $string['eventoverrideupdated'] = 'Quiz override updated'; diff --git a/mod/quiz/tests/events_test.php b/mod/quiz/tests/events_test.php index bf97c8cca4e..6ac30aff680 100644 --- a/mod/quiz/tests/events_test.php +++ b/mod/quiz/tests/events_test.php @@ -531,4 +531,42 @@ class mod_quiz_events_testcase extends advanced_testcase { $this->assertEventLegacyLogData($expected, $event); $this->assertEventContextNotUsed($event); } + + /** + * Test the attempt viewed event. + * + * There is no external API for continuing an attempt, so the unit test will simply + * create and trigger the event and ensure the event data is returned as expected. + */ + public function test_attempt_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_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_viewed', $event); + $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context()); + $expected = array($course->id, 'quiz', 'continue attempt', 'review.php?attempt=1', $quiz->id, $quiz->cmid); + $this->assertEventLegacyLogData($expected, $event); + $this->assertEventContextNotUsed($event); + } }