eacc703e27b2911ac5cc2b608a343ae481bce74f
[moodle.git] / mod / quiz / review.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 review of a particular quiz attempt
19  *
20  * It is used either by the student whose attempts this is, after the attempt,
21  * or by a teacher reviewing another's attempt during or afterwards.
22  *
23  * @package   mod_quiz
24  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
29 require_once(dirname(__FILE__) . '/../../config.php');
30 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
31 require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
33 $attemptid = required_param('attempt', PARAM_INT);
34 $page      = optional_param('page', 0, PARAM_INT);
35 $showall   = optional_param('showall', 0, PARAM_BOOL);
37 $url = new moodle_url('/mod/quiz/review.php', array('attempt'=>$attemptid));
38 if ($page !== 0) {
39     $url->param('page', $page);
40 }
41 if ($showall !== 0) {
42     $url->param('showall', $showall);
43 }
44 $PAGE->set_url($url);
46 $attemptobj = quiz_attempt::create($attemptid);
47 $page = $attemptobj->force_page_number_into_range($page);
49 // Check login.
50 require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
51 $attemptobj->check_review_capability();
53 // Create an object to manage all the other (non-roles) access rules.
54 $accessmanager = $attemptobj->get_access_manager(time());
55 $accessmanager->setup_attempt_page($PAGE);
57 $options = $attemptobj->get_display_options(true);
59 // Check permissions.
60 if ($attemptobj->is_own_attempt()) {
61     if (!$attemptobj->is_finished()) {
62         redirect($attemptobj->attempt_url(null, $page));
64     } else if (!$options->attempt) {
65         $accessmanager->back_to_view_page($PAGE->get_renderer('mod_quiz'),
66                 $attemptobj->cannot_review_message());
67     }
69 } else if (!$attemptobj->is_review_allowed()) {
70     throw new moodle_quiz_exception($attemptobj->get_quizobj(), 'noreviewattempt');
71 }
73 // Load the questions and states needed by this page.
74 if ($showall) {
75     $questionids = $attemptobj->get_slots();
76 } else {
77     $questionids = $attemptobj->get_slots($page);
78 }
80 // Save the flag states, if they are being changed.
81 if ($options->flags == question_display_options::EDITABLE && optional_param('savingflags', false,
82         PARAM_BOOL)) {
83     require_sesskey();
84     $attemptobj->save_question_flags();
85     redirect($attemptobj->review_url(null, $page, $showall));
86 }
88 // Log this review.
89 add_to_log($attemptobj->get_courseid(), 'quiz', 'review', 'review.php?attempt=' .
90         $attemptobj->get_attemptid(), $attemptobj->get_quizid(), $attemptobj->get_cmid());
92 // Work out appropriate title and whether blocks should be shown.
93 if ($attemptobj->is_preview_user() && $attemptobj->is_own_attempt()) {
94     $strreviewtitle = get_string('reviewofpreview', 'quiz');
95     navigation_node::override_active_url($attemptobj->start_attempt_url());
97 } else {
98     $strreviewtitle = get_string('reviewofattempt', 'quiz', $attemptobj->get_attempt_number());
99     if (empty($attemptobj->get_quiz()->showblocks) && !$attemptobj->is_preview_user()) {
100         $PAGE->blocks->show_only_fake_blocks();
101     }
104 // Set up the page header.
105 $headtags = $attemptobj->get_html_head_contributions($page, $showall);
106 $PAGE->set_title(format_string($attemptobj->get_quiz_name()));
107 $PAGE->set_heading($attemptobj->get_course()->fullname);
109 // Summary table start. ============================================================================
111 // Work out some time-related things.
112 $attempt = $attemptobj->get_attempt();
113 $quiz = $attemptobj->get_quiz();
114 $overtime = 0;
116 if ($attempt->state == quiz_attempt::FINISHED) {
117     if ($timetaken = ($attempt->timefinish - $attempt->timestart)) {
118         if ($quiz->timelimit && $timetaken > ($quiz->timelimit + 60)) {
119             $overtime = $timetaken - $quiz->timelimit;
120             $overtime = format_time($overtime);
121         }
122         $timetaken = format_time($timetaken);
123     } else {
124         $timetaken = "-";
125     }
126 } else {
127     $timetaken = get_string('unfinished', 'quiz');
130 // Prepare summary informat about the whole attempt.
131 $summarydata = array();
132 if (!$attemptobj->get_quiz()->showuserpicture && $attemptobj->get_userid() != $USER->id) {
133     // If showuserpicture is true, the picture is shown elsewhere, so don't repeat it.
134     $student = $DB->get_record('user', array('id' => $attemptobj->get_userid()));
135     $usrepicture = new user_picture($student);
136     $usrepicture->courseid = $attemptobj->get_courseid();
137     $summarydata['user'] = array(
138         'title'   => $usrepicture,
139         'content' => new action_link(new moodle_url('/user/view.php', array(
140                                 'id' => $student->id, 'course' => $attemptobj->get_courseid())),
141                           fullname($student, true)),
142     );
145 if ($attemptobj->has_capability('mod/quiz:viewreports')) {
146     $attemptlist = $attemptobj->links_to_other_attempts($attemptobj->review_url(null, $page,
147             $showall));
148     if ($attemptlist) {
149         $summarydata['attemptlist'] = array(
150             'title'   => get_string('attempts', 'quiz'),
151             'content' => $attemptlist,
152         );
153     }
156 // Timing information.
157 $summarydata['startedon'] = array(
158     'title'   => get_string('startedon', 'quiz'),
159     'content' => userdate($attempt->timestart),
160 );
162 $summarydata['state'] = array(
163     'title'   => get_string('attemptstate', 'quiz'),
164     'content' => quiz_attempt::state_name($attempt->state),
165 );
167 if ($attempt->state == quiz_attempt::FINISHED) {
168     $summarydata['completedon'] = array(
169         'title'   => get_string('completedon', 'quiz'),
170         'content' => userdate($attempt->timefinish),
171     );
172     $summarydata['timetaken'] = array(
173         'title'   => get_string('timetaken', 'quiz'),
174         'content' => $timetaken,
175     );
178 if (!empty($overtime)) {
179     $summarydata['overdue'] = array(
180         'title'   => get_string('overdue', 'quiz'),
181         'content' => $overtime,
182     );
185 // Show marks (if the user is allowed to see marks at the moment).
186 $grade = quiz_rescale_grade($attempt->sumgrades, $quiz, false);
187 if ($options->marks >= question_display_options::MARK_AND_MAX && quiz_has_grades($quiz)) {
189     if ($attempt->state != quiz_attempt::FINISHED) {
190         $summarydata['grade'] = array(
191             'title'   => get_string('grade', 'quiz'),
192             'content' => get_string('attemptstillinprogress', 'quiz'),
193         );
195     } else if (is_null($grade)) {
196         $summarydata['grade'] = array(
197             'title'   => get_string('grade', 'quiz'),
198             'content' => quiz_format_grade($quiz, $grade),
199         );
201     } else {
202         // Show raw marks only if they are different from the grade (like on the view page).
203         if ($quiz->grade != $quiz->sumgrades) {
204             $a = new stdClass();
205             $a->grade = quiz_format_grade($quiz, $attempt->sumgrades);
206             $a->maxgrade = quiz_format_grade($quiz, $quiz->sumgrades);
207             $summarydata['marks'] = array(
208                 'title'   => get_string('marks', 'quiz'),
209                 'content' => get_string('outofshort', 'quiz', $a),
210             );
211         }
213         // Now the scaled grade.
214         $a = new stdClass();
215         $a->grade = html_writer::tag('b', quiz_format_grade($quiz, $grade));
216         $a->maxgrade = quiz_format_grade($quiz, $quiz->grade);
217         if ($quiz->grade != 100) {
218             $a->percent = html_writer::tag('b', format_float(
219                     $attempt->sumgrades * 100 / $quiz->sumgrades, 0));
220             $formattedgrade = get_string('outofpercent', 'quiz', $a);
221         } else {
222             $formattedgrade = get_string('outof', 'quiz', $a);
223         }
224         $summarydata['grade'] = array(
225             'title'   => get_string('grade', 'quiz'),
226             'content' => $formattedgrade,
227         );
228     }
231 // Feedback if there is any, and the user is allowed to see it now.
232 $feedback = $attemptobj->get_overall_feedback($grade);
233 if ($options->overallfeedback && $feedback) {
234     $summarydata['feedback'] = array(
235         'title'   => get_string('feedback', 'quiz'),
236         'content' => $feedback,
237     );
240 // Summary table end. ==============================================================================
242 if ($showall) {
243     $slots = $attemptobj->get_slots();
244     $lastpage = true;
245 } else {
246     $slots = $attemptobj->get_slots($page);
247     $lastpage = $attemptobj->is_last_page($page);
250 $output = $PAGE->get_renderer('mod_quiz');
252 // Arrange for the navigation to be displayed.
253 $navbc = $attemptobj->get_navigation_panel($output, 'quiz_review_nav_panel', $page, $showall);
254 $regions = $PAGE->blocks->get_regions();
255 $PAGE->blocks->add_fake_block($navbc, reset($regions));
257 echo $output->review_page($attemptobj, $slots, $page, $showall, $lastpage, $options, $summarydata);