diff --git a/mod/quiz/classes/event/report_viewed.php b/mod/quiz/classes/event/report_viewed.php new file mode 100644 index 00000000000..da2d3012fa0 --- /dev/null +++ b/mod/quiz/classes/event/report_viewed.php @@ -0,0 +1,105 @@ +. + +/** + * Report viewed event. + * + * @property-read array $other { + * Extra information about event. + * + * - int quizid: the id of the quiz. + * - string reportname: the name of the report. + * } + * + * @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 report_viewed extends \core\event\base { + + /** + * Init method. + * + * @return void + */ + protected function init() { + $this->data['crud'] = 'r'; + $this->data['edulevel'] = self::LEVEL_TEACHING; + } + + /** + * Return localised event name. + * + * @return string + */ + public static function get_name() { + return get_string('eventreportviewed', 'mod_quiz'); + } + + /** + * Returns description of what happened. + * + * @return string + */ + public function get_description() { + return 'User with id ' . $this->userid . ' viewed the report \'' . s($this->other['reportname']) . '\' for the quiz + with the id ' . $this->other['quizid']; + } + + /** + * Get URL related to the action. + * + * @return \moodle_url + */ + public function get_url() { + return new \moodle_url('/mod/quiz/report.php', array('id' => $this->contextinstanceid, + 'mode' => $this->other['reportname'])); + } + + /** + * Return the legacy event log data. + * + * @return array + */ + protected function get_legacy_logdata() { + return array($this->courseid, 'quiz', 'report', 'report.php?id=' . $this->contextinstanceid . '&mode=' . + $this->other['reportname'], $this->other['quizid'], $this->contextinstanceid); + } + + /** + * Custom validation. + * + * @throws \coding_exception + * @return void + */ + protected function validate_data() { + parent::validate_data(); + + if (!isset($this->other['quizid'])) { + throw new \coding_exception('The \'quizid\' must be set in other.'); + } + + if (!isset($this->other['reportname'])) { + throw new \coding_exception('The \'reportname\' must be set in other.'); + } + } +} diff --git a/mod/quiz/lang/en/quiz.php b/mod/quiz/lang/en/quiz.php index 78cfb540b91..aaa6bf7be7c 100644 --- a/mod/quiz/lang/en/quiz.php +++ b/mod/quiz/lang/en/quiz.php @@ -311,6 +311,7 @@ $string['eventquizattemptabandoned'] = 'Quiz attempt abandoned'; $string['eventquizattempttimelimitexceeded'] = 'Quiz attempt time limit exceeded'; $string['eventquizattemptstarted'] = 'Quiz attempt started'; $string['eventquizattemptsubmitted'] = 'Quiz attempt submitted'; +$string['eventreportviewed'] = 'Quiz report viewed'; $string['everynquestions'] = 'Every {$a} questions'; $string['everyquestion'] = 'Every question'; $string['everythingon'] = 'Everything on'; diff --git a/mod/quiz/report.php b/mod/quiz/report.php index ddc8c52b30a..2be5173f549 100644 --- a/mod/quiz/report.php +++ b/mod/quiz/report.php @@ -82,9 +82,6 @@ if (!is_readable("report/$mode/report.php")) { print_error('reportnotfound', 'quiz', '', $mode); } -add_to_log($course->id, 'quiz', 'report', 'report.php?id=' . $cm->id . '&mode=' . $mode, - $quiz->id, $cm->id); - // Open the selected quiz report and display it. $file = $CFG->dirroot . '/mod/quiz/report/' . $mode . '/report.php'; if (is_readable($file)) { @@ -100,3 +97,16 @@ $report->display($quiz, $cm, $course); // Print footer. echo $OUTPUT->footer(); + +// Log that this report was viewed. +$params = array( + 'context' => $context, + 'other' => array( + 'quizid' => $quiz->id, + 'reportname' => $mode + ) +); +$event = \mod_quiz\event\report_viewed::create($params); +$event->add_record_snapshot('course', $course); +$event->add_record_snapshot('quiz', $quiz); +$event->trigger(); diff --git a/mod/quiz/tests/events_test.php b/mod/quiz/tests/events_test.php index 142fec2830c..8603bd8c1ae 100644 --- a/mod/quiz/tests/events_test.php +++ b/mod/quiz/tests/events_test.php @@ -280,4 +280,41 @@ class mod_quiz_events_testcase extends advanced_testcase { $this->assertEventLegacyLogData($expected, $event); $this->assertEventContextNotUsed($event); } + + /** + * Test the report viewed event. + * + * There is no external API for viewing reports, so the unit test will simply + * create and trigger the event and ensure the event data is returned as expected. + */ + public function test_report_viewed() { + $this->resetAfterTest(); + + $this->setAdminUser(); + $course = $this->getDataGenerator()->create_course(); + $quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id)); + + $params = array( + 'context' => $context = context_module::instance($quiz->cmid), + 'other' => array( + 'quizid' => $quiz->id, + 'reportname' => 'overview' + ) + ); + $event = \mod_quiz\event\report_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\report_viewed', $event); + $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context()); + $expected = array($course->id, 'quiz', 'report', 'report.php?id=' . $quiz->cmid . '&mode=overview', + $quiz->id, $quiz->cmid); + $this->assertEventLegacyLogData($expected, $event); + $this->assertEventContextNotUsed($event); + } }