MDL-40063 mod_quiz: replaced 'view summary' add_to_log call with an event
[moodle.git] / mod / quiz / summary.php
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/>.
17 /**
18  * This page prints a summary of a quiz attempt before it is submitted.
19  *
20  * @package   mod_quiz
21  * @copyright 2009 The Open University
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
26 require_once(dirname(__FILE__) . '/../../config.php');
27 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
29 $attemptid = required_param('attempt', PARAM_INT); // The attempt to summarise.
31 $PAGE->set_url('/mod/quiz/summary.php', array('attempt' => $attemptid));
33 $attemptobj = quiz_attempt::create($attemptid);
35 // Check login.
36 require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
38 // Check that this attempt belongs to this user.
39 if ($attemptobj->get_userid() != $USER->id) {
40     if ($attemptobj->has_capability('mod/quiz:viewreports')) {
41         redirect($attemptobj->review_url(null));
42     } else {
43         throw new moodle_quiz_exception($attemptobj->get_quizobj(), 'notyourattempt');
44     }
45 }
47 // Check capabilites.
48 if (!$attemptobj->is_preview_user()) {
49     $attemptobj->require_capability('mod/quiz:attempt');
50 }
52 if ($attemptobj->is_preview_user()) {
53     navigation_node::override_active_url($attemptobj->start_attempt_url());
54 }
56 // Check access.
57 $accessmanager = $attemptobj->get_access_manager(time());
58 $accessmanager->setup_attempt_page($PAGE);
59 $output = $PAGE->get_renderer('mod_quiz');
60 $messages = $accessmanager->prevent_access();
61 if (!$attemptobj->is_preview_user() && $messages) {
62     print_error('attempterror', 'quiz', $attemptobj->view_url(),
63             $output->access_messages($messages));
64 }
65 if ($accessmanager->is_preflight_check_required($attemptobj->get_attemptid())) {
66     redirect($attemptobj->start_attempt_url(null));
67 }
69 $displayoptions = $attemptobj->get_display_options(false);
71 // If the attempt is now overdue, or abandoned, deal with that.
72 $attemptobj->handle_if_time_expired(time(), true);
74 // If the attempt is already closed, redirect them to the review page.
75 if ($attemptobj->is_finished()) {
76     redirect($attemptobj->review_url());
77 }
79 // Arrange for the navigation to be displayed.
80 if (empty($attemptobj->get_quiz()->showblocks)) {
81     $PAGE->blocks->show_only_fake_blocks();
82 }
84 $navbc = $attemptobj->get_navigation_panel($output, 'quiz_attempt_nav_panel', -1);
85 $regions = $PAGE->blocks->get_regions();
86 $PAGE->blocks->add_fake_block($navbc, reset($regions));
88 $PAGE->navbar->add(get_string('summaryofattempt', 'quiz'));
89 $PAGE->set_title($attemptobj->get_quiz_name());
90 $PAGE->set_heading($attemptobj->get_course()->fullname);
92 // Display the page.
93 echo $output->summary_page($attemptobj, $displayoptions);
95 // Log this page view.
96 $params = array(
97     'objectid' => $attemptobj->get_attemptid(),
98     'relateduserid' => $attemptobj->get_userid(),
99     'courseid' => $attemptobj->get_courseid(),
100     'context' => context_module::instance($attemptobj->get_cmid()),
101     'other' => array(
102         'quizid' => $attemptobj->get_quizid()
103     )
104 );
105 $event = \mod_quiz\event\attempt_summary_viewed::create($params);
106 $event->add_record_snapshot('quiz_attempts', $attemptobj->get_attempt());
107 $event->trigger();