-
Notifications
You must be signed in to change notification settings - Fork 3
/
report.php
370 lines (321 loc) · 15 KB
/
report.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<?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/>.
/**
* This file defines the quiz archive report class.
*
* @package quiz_archive
* @copyright 2018 Luca Bösch <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use mod_quiz\local\reports\report_base;
use mod_quiz\output\attempt_summary_information;
use mod_quiz\quiz_attempt;
use mod_quiz\question\display_options;
use mod_quiz\local\reports\attempts_report;
defined('MOODLE_INTERNAL') || die();
// This work-around is required until Moodle 4.2 is the lowest version we support.
if (class_exists('\mod_quiz\local\reports\report_base')) {
class_alias('\mod_quiz\local\reports\attempts_report', '\quiz_archive_report_parent_class_alias');
class_alias('\mod_quiz\quiz_attempt', '\quiz_archive_quiz_attempt');
class_alias('\mod_quiz\question\display_options', '\quiz_archive_mod_quiz_display_options');
} else {
require_once($CFG->dirroot . '/mod/quiz/report/attemptsreport.php');
require_once($CFG->dirroot . '/mod/quiz/attemptlib.php');
class_alias('\quiz_attempts_report', '\quiz_archive_report_parent_class_alias');
class_alias('\quiz_attempt', '\quiz_archive_quiz_attempt');
class_alias('\mod_quiz_display_options', '\quiz_archive_mod_quiz_display_options');
}
require_once($CFG->dirroot . '/mod/quiz/report/archive/archive_options.php');
require_once($CFG->dirroot . '/mod/quiz/report/archive/archive_form.php');
require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
require_once($CFG->dirroot . '/mod/quiz/locallib.php');
require_once($CFG->libdir . '/pagelib.php');
require_once($CFG->libdir . '/environmentlib.php');
/**
* Quiz report subclass for the archive report.
*
* This report lists some combination of
* * what question each student saw (this makes sense if random questions were used).
* * the response they gave.
*
* @package quiz_archive
* @copyright 2018 Luca Bösch <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class quiz_archive_report extends quiz_archive_report_parent_class_alias {
/** @var object the questions that comprise this quiz.. */
protected $questions;
/** @var object course module object. */
protected $cm;
/** @var object course object. */
protected $course;
/** @var object display options for the report. */
protected $options;
/**
* Display the report.
*
* @param object $quiz this quiz.
* @param object $cm the course-module for this quiz.
* @param object $course the course we are in.
* @return bool
* @throws moodle_exception
*/
public function display($quiz, $cm, $course) {
global $OUTPUT;
$this->init('archive', 'quiz_archive_settings_form', $quiz, $cm, $course);
$this->options = new quiz_archive_options('archive', $quiz, $cm, $course);
if ($fromform = $this->form->get_data()) {
$this->options->process_settings_from_form($fromform);
} else {
$this->options->process_settings_from_params();
}
$this->form->set_data($this->options->get_initial_form_data());
$this->quizobj = $quiz;
$this->cm = $cm;
$this->course = $course;
// Get the URL options.
$slot = optional_param('slot', null, PARAM_INT);
$grade = optional_param('grade', null, PARAM_ALPHA);
if (!in_array($grade, ['all', 'needsgrading', 'autograded', 'manuallygraded'])) {
$grade = null;
}
// Check permissions.
$this->context = context_module::instance($cm->id);
require_capability('mod/quiz:grade', $this->context);
// Get the list of questions in this quiz.
$this->questions = quiz_report_get_significant_questions($quiz);
if ($slot && !array_key_exists($slot, $this->questions)) {
throw new moodle_exception('unknownquestion', 'quiz_archive');
}
$hasquestions = quiz_has_questions($quiz->id);
// Start output.
$this->print_header_and_tabs($cm, $course, $quiz, 'archive');
$this->form->display();
// What sort of page to display?
if (!$hasquestions) {
echo $OUTPUT->notification(get_string('nothingfound', 'quiz_grading'));
} else {
$this->display_archive();
}
return true;
}
/**
* Display all attempts.
*/
protected function display_archive() {
global $OUTPUT;
$studentattempts = $this->quizreportgetstudentandattempts($this->quizobj);
if (count($studentattempts) === 0) {
echo $OUTPUT->notification(get_string('nothingfound', 'quiz_grading'));
}
foreach ($studentattempts as $studentattempt) {
echo $this->quiz_report_get_student_attempt($studentattempt['attemptid'], $studentattempt['userid']);
}
}
/**
* Get the ids of students in this quiz, in order.
* @param object $quiz the quiz.
* @return array of stdClass objects with fields
* ->userid, ->attemptid.
*/
protected function quizreportgetstudentandattempts($quiz) {
global $DB;
// Construct the SQL.
$sql = "SELECT DISTINCT quiza.id attemptid, u.id userid, u.firstname, u.lastname FROM {user} u " .
"LEFT JOIN {quiz_attempts} quiza " .
"ON quiza.userid = u.id WHERE quiza.quiz = :quizid AND quiza.preview = 0 ORDER BY u.lastname ASC, u.firstname ASC";
$params = ['quizid' => $this->quizobj->id];
$results = $DB->get_records_sql($sql, $params);
$students = [];
foreach ($results as $result) {
array_push($students, ['userid' => $result->userid, 'attemptid' => $result->attemptid]);
}
return $students;
}
/**
* Get the attempts of a students in this quiz.
* @param int $attemptid the attempt id.
* @param int $userid the user id.
*/
protected function quiz_report_get_student_attempt($attemptid, $userid) {
global $DB, $PAGE, $CFG;
$attemptobj = quiz_create_attempt_handling_errors($attemptid, $this->cm->id);
// Summary table start.
// ============================================================================.
// Work out some time-related things.
$attempt = $attemptobj->get_attempt();
$quiz = $attemptobj->get_quiz();
$options = quiz_archive_mod_quiz_display_options::make_from_quiz($this->quizobj, quiz_attempt_state($quiz, $attempt));
$options->flags = quiz_get_flag_option($attempt, context_module::instance($this->cm->id));
$overtime = 0;
if ($attempt->state == quiz_archive_quiz_attempt::FINISHED) {
if ($timetaken = ($attempt->timefinish - $attempt->timestart)) {
if ($quiz->timelimit && $timetaken > ($quiz->timelimit + 60)) {
$overtime = $timetaken - $quiz->timelimit;
$overtime = format_time($overtime);
}
$timetaken = format_time($timetaken);
} else {
$timetaken = "-";
}
} else {
$timetaken = get_string('unfinished', 'quiz');
}
// Prepare summary information about the whole attempt.
$summarydata = [];
// We want the user information no matter what.
$student = $DB->get_record('user', ['id' => $attemptobj->get_userid()]);
$userpicture = new user_picture($student);
$userpicture->courseid = $attemptobj->get_courseid();
$summarydata['user'] = [
'title' => $userpicture,
'content' => new action_link(new moodle_url('/user/view.php', [
'id' => $student->id, 'course' => $attemptobj->get_courseid(), ]),
fullname($student, true)),
];
// Timing information.
$summarydata['startedon'] = [
'title' => get_string('startedon', 'quiz'),
'content' => userdate($attempt->timestart),
];
$summarydata['state'] = [
'title' => get_string('attemptstate', 'quiz'),
'content' => quiz_archive_quiz_attempt::state_name($attempt->state),
];
if ($attempt->state == quiz_archive_quiz_attempt::FINISHED) {
$summarydata['completedon'] = [
'title' => get_string('completedon', 'quiz'),
'content' => userdate($attempt->timefinish),
];
$currentversion = normalize_version($CFG->release);
if (version_compare($currentversion, '4.4', "<")) {
// Beginning Moodle 4.4, the string 'timetaken' is deprecated and not used anymore.
$summarydata['timetaken'] = [
'title' => get_string('timetaken', 'quiz'),
'content' => $timetaken,
];
}
}
if (!empty($overtime)) {
$summarydata['overdue'] = [
'title' => get_string('overdue', 'quiz'),
'content' => $overtime,
];
}
// Show marks (if the user is allowed to see marks at the moment).
$grade = quiz_rescale_grade($attempt->sumgrades, $quiz, false);
if ($options->marks >= quiz_archive_mod_quiz_display_options::MARK_AND_MAX && quiz_has_grades($quiz)) {
if ($attempt->state != quiz_archive_quiz_attempt::FINISHED) {
// Cannot display grade.
echo '';
} else if (is_null($grade)) {
if (get_string_manager()->string_exists('gradenoun', 'moodle')) {
$gradenounstring = get_string('gradenoun');
} else {
$gradenounstring = get_string('grade', 'quiz');
}
$summarydata['grade'] = [
'title' => $gradenounstring,
'content' => quiz_format_grade($quiz, $grade),
];
} else {
// Show raw marks only if they are different from the grade (like on the view page).
if ($quiz->grade != $quiz->sumgrades) {
$a = new stdClass();
$a->grade = quiz_format_grade($quiz, $attempt->sumgrades);
$a->maxgrade = quiz_format_grade($quiz, $quiz->sumgrades);
$summarydata['marks'] = [
'title' => get_string('marks', 'quiz'),
'content' => get_string('outofshort', 'quiz', $a),
];
}
// Now the scaled grade.
$a = new stdClass();
$a->grade = html_writer::tag('b', quiz_format_grade($quiz, $grade));
$a->maxgrade = quiz_format_grade($quiz, $quiz->grade);
if ($quiz->grade != 100) {
$a->percent = html_writer::tag('b', format_float(
$attempt->sumgrades * 100 / $quiz->sumgrades, 0));
$formattedgrade = get_string('outofpercent', 'quiz', $a);
} else {
$formattedgrade = get_string('outof', 'quiz', $a);
}
if (get_string_manager()->string_exists('gradenoun', 'moodle')) {
$gradenounstring = get_string('gradenoun');
} else {
$gradenounstring = get_string('grade', 'quiz');
}
$summarydata['grade'] = [
'title' => $gradenounstring,
'content' => $formattedgrade,
];
}
}
// Any additional summary data from the behaviour.
$summarydata = array_merge($summarydata, $attemptobj->get_additional_summary_data($options));
// Feedback if there is any, and the user is allowed to see it now.
$feedback = $attemptobj->get_overall_feedback($grade);
if ($options->overallfeedback && $feedback) {
$summarydata['feedback'] = [
'title' => get_string('feedback', 'quiz'),
'content' => $feedback,
];
}
// Summary table end.
// ==============================================================================.
$slots = $attemptobj->get_slots();
$renderer = $PAGE->get_renderer('mod_quiz');
$string = '';
if (method_exists($renderer, 'review_attempt_summary')) {
$displayoptions = $attemptobj->get_display_options(true);
$summarydata = attempt_summary_information::create_for_attempt(
$attemptobj, $displayoptions);
$string .= $renderer->review_attempt_summary($summarydata, 0);
} else {
$string .= $renderer->review_summary_table($summarydata, 0);
}
// Display the questions. The overall goal is to have question_display_options from question/engine/lib.php
// set so they would show what we wand and not show what we don't want.
// Here we would call questions function on the renderer from mod/quiz/renderer.php but instead we do this
// manually.
foreach ($slots as $slot) {
// Here we would call render_question_helper function on the quiz_attempt from mod/quiz/renderer.php but
// instead we do this manually.
$originalslot = $attemptobj->get_original_slot($slot);
$number = $attemptobj->get_question_number($originalslot);
$displayoptions = $attemptobj->get_display_options_with_edit_link(true, $slot, "");
$displayoptions->marks = 2;
$displayoptions->manualcomment = 1;
$displayoptions->feedback = 1;
$displayoptions->history = $this->options->showhistory;
$displayoptions->rightanswer = $this->options->showright;
$displayoptions->correctness = 1;
$displayoptions->numpartscorrect = 1;
$displayoptions->flags = 1;
$displayoptions->manualcommentlink = 0;
if ($slot != $originalslot) {
$attemptobj->get_question_attempt($slot)->set_max_mark(
$attemptobj->get_question_attempt($originalslot)->get_max_mark());
}
$quba = question_engine::load_questions_usage_by_activity($attemptobj->get_uniqueid());
if (method_exists($quba, 'preload_all_step_users')) {
$quba->preload_all_step_users();
}
$string .= $quba->render_question($slot, $displayoptions, $number);
}
return $string;
}
}