Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

   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/>.
  16  
  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   */
  27  
  28  
  29  require_once(__DIR__ . '/../../config.php');
  30  require_once($CFG->dirroot . '/mod/quiz/locallib.php');
  31  require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
  32  
  33  $attemptid = required_param('attempt', PARAM_INT);
  34  $page      = optional_param('page', 0, PARAM_INT);
  35  $showall   = optional_param('showall', null, PARAM_BOOL);
  36  $cmid      = optional_param('cmid', null, PARAM_INT);
  37  
  38  $url = new moodle_url('/mod/quiz/review.php', array('attempt'=>$attemptid));
  39  if ($page !== 0) {
  40      $url->param('page', $page);
  41  } else if ($showall) {
  42      $url->param('showall', $showall);
  43  }
  44  $PAGE->set_url($url);
  45  
  46  $attemptobj = quiz_create_attempt_handling_errors($attemptid, $cmid);
  47  $attemptobj->preload_all_attempt_step_users();
  48  $page = $attemptobj->force_page_number_into_range($page);
  49  
  50  // Now we can validate the params better, re-genrate the page URL.
  51  if ($showall === null) {
  52      $showall = $page == 0 && $attemptobj->get_default_show_all('review');
  53  }
  54  $PAGE->set_url($attemptobj->review_url(null, $page, $showall));
  55  
  56  // Check login.
  57  require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
  58  $attemptobj->check_review_capability();
  59  
  60  // Create an object to manage all the other (non-roles) access rules.
  61  $accessmanager = $attemptobj->get_access_manager(time());
  62  $accessmanager->setup_attempt_page($PAGE);
  63  
  64  $options = $attemptobj->get_display_options(true);
  65  
  66  // Check permissions - warning there is similar code in reviewquestion.php and
  67  // quiz_attempt::check_file_access. If you change on, change them all.
  68  if ($attemptobj->is_own_attempt()) {
  69      if (!$attemptobj->is_finished()) {
  70          redirect($attemptobj->attempt_url(null, $page));
  71  
  72      } else if (!$options->attempt) {
  73          $accessmanager->back_to_view_page($PAGE->get_renderer('mod_quiz'),
  74                  $attemptobj->cannot_review_message());
  75      }
  76  
  77  } else if (!$attemptobj->is_review_allowed()) {
  78      throw new moodle_quiz_exception($attemptobj->get_quizobj(), 'noreviewattempt');
  79  }
  80  
  81  // Load the questions and states needed by this page.
  82  if ($showall) {
  83      $questionids = $attemptobj->get_slots();
  84  } else {
  85      $questionids = $attemptobj->get_slots($page);
  86  }
  87  
  88  // Save the flag states, if they are being changed.
  89  if ($options->flags == question_display_options::EDITABLE && optional_param('savingflags', false,
  90          PARAM_BOOL)) {
  91      require_sesskey();
  92      $attemptobj->save_question_flags();
  93      redirect($attemptobj->review_url(null, $page, $showall));
  94  }
  95  
  96  // Work out appropriate title and whether blocks should be shown.
  97  if ($attemptobj->is_own_preview()) {
  98      navigation_node::override_active_url($attemptobj->start_attempt_url());
  99  
 100  } else {
 101      if (empty($attemptobj->get_quiz()->showblocks) && !$attemptobj->is_preview_user()) {
 102          $PAGE->blocks->show_only_fake_blocks();
 103      }
 104  }
 105  
 106  // Set up the page header.
 107  $headtags = $attemptobj->get_html_head_contributions($page, $showall);
 108  $PAGE->set_title($attemptobj->review_page_title($page, $showall));
 109  $PAGE->set_heading($attemptobj->get_course()->fullname);
 110  
 111  // Summary table start. ============================================================================
 112  
 113  // Work out some time-related things.
 114  $attempt = $attemptobj->get_attempt();
 115  $quiz = $attemptobj->get_quiz();
 116  $overtime = 0;
 117  
 118  if ($attempt->state == quiz_attempt::FINISHED) {
 119      if ($timetaken = ($attempt->timefinish - $attempt->timestart)) {
 120          if ($quiz->timelimit && $timetaken > ($quiz->timelimit + 60)) {
 121              $overtime = $timetaken - $quiz->timelimit;
 122              $overtime = format_time($overtime);
 123          }
 124          $timetaken = format_time($timetaken);
 125      } else {
 126          $timetaken = "-";
 127      }
 128  } else {
 129      $timetaken = get_string('unfinished', 'quiz');
 130  }
 131  
 132  // Prepare summary informat about the whole attempt.
 133  $summarydata = array();
 134  if (!$attemptobj->get_quiz()->showuserpicture && $attemptobj->get_userid() != $USER->id) {
 135      // If showuserpicture is true, the picture is shown elsewhere, so don't repeat it.
 136      $student = $DB->get_record('user', array('id' => $attemptobj->get_userid()));
 137      $userpicture = new user_picture($student);
 138      $userpicture->courseid = $attemptobj->get_courseid();
 139      $summarydata['user'] = array(
 140          'title'   => $userpicture,
 141          'content' => new action_link(new moodle_url('/user/view.php', array(
 142                                  'id' => $student->id, 'course' => $attemptobj->get_courseid())),
 143                            fullname($student, true)),
 144      );
 145  }
 146  
 147  if ($attemptobj->has_capability('mod/quiz:viewreports')) {
 148      $attemptlist = $attemptobj->links_to_other_attempts($attemptobj->review_url(null, $page,
 149              $showall));
 150      if ($attemptlist) {
 151          $summarydata['attemptlist'] = array(
 152              'title'   => get_string('attempts', 'quiz'),
 153              'content' => $attemptlist,
 154          );
 155      }
 156  }
 157  
 158  // Timing information.
 159  $summarydata['startedon'] = array(
 160      'title'   => get_string('startedon', 'quiz'),
 161      'content' => userdate($attempt->timestart),
 162  );
 163  
 164  $summarydata['state'] = array(
 165      'title'   => get_string('attemptstate', 'quiz'),
 166      'content' => quiz_attempt::state_name($attempt->state),
 167  );
 168  
 169  if ($attempt->state == quiz_attempt::FINISHED) {
 170      $summarydata['completedon'] = array(
 171          'title'   => get_string('completedon', 'quiz'),
 172          'content' => userdate($attempt->timefinish),
 173      );
 174      $summarydata['timetaken'] = array(
 175          'title'   => get_string('timetaken', 'quiz'),
 176          'content' => $timetaken,
 177      );
 178  }
 179  
 180  if (!empty($overtime)) {
 181      $summarydata['overdue'] = array(
 182          'title'   => get_string('overdue', 'quiz'),
 183          'content' => $overtime,
 184      );
 185  }
 186  
 187  // Show marks (if the user is allowed to see marks at the moment).
 188  $grade = quiz_rescale_grade($attempt->sumgrades, $quiz, false);
 189  if ($options->marks >= question_display_options::MARK_AND_MAX && quiz_has_grades($quiz)) {
 190  
 191      if ($attempt->state != quiz_attempt::FINISHED) {
 192          // Cannot display grade.
 193  
 194      } else if (is_null($grade)) {
 195          $summarydata['grade'] = array(
 196              'title'   => get_string('grade', 'quiz'),
 197              'content' => quiz_format_grade($quiz, $grade),
 198          );
 199  
 200      } else {
 201          // Show raw marks only if they are different from the grade (like on the view page).
 202          if ($quiz->grade != $quiz->sumgrades) {
 203              $a = new stdClass();
 204              $a->grade = quiz_format_grade($quiz, $attempt->sumgrades);
 205              $a->maxgrade = quiz_format_grade($quiz, $quiz->sumgrades);
 206              $summarydata['marks'] = array(
 207                  'title'   => get_string('marks', 'quiz'),
 208                  'content' => get_string('outofshort', 'quiz', $a),
 209              );
 210          }
 211  
 212          // Now the scaled grade.
 213          $a = new stdClass();
 214          $a->grade = html_writer::tag('b', quiz_format_grade($quiz, $grade));
 215          $a->maxgrade = quiz_format_grade($quiz, $quiz->grade);
 216          if ($quiz->grade != 100) {
 217              // Show the percentage using the configured number of decimal places,
 218              // but without trailing zeroes.
 219              $a->percent = html_writer::tag('b', format_float(
 220                      $attempt->sumgrades * 100 / $quiz->sumgrades,
 221                      $quiz->decimalpoints, true, true));
 222              $formattedgrade = get_string('outofpercent', 'quiz', $a);
 223          } else {
 224              $formattedgrade = get_string('outof', 'quiz', $a);
 225          }
 226          $summarydata['grade'] = array(
 227              'title'   => get_string('grade', 'quiz'),
 228              'content' => $formattedgrade,
 229          );
 230      }
 231  }
 232  
 233  // Any additional summary data from the behaviour.
 234  $summarydata = array_merge($summarydata, $attemptobj->get_additional_summary_data($options));
 235  
 236  // Feedback if there is any, and the user is allowed to see it now.
 237  $feedback = $attemptobj->get_overall_feedback($grade);
 238  if ($options->overallfeedback && $feedback) {
 239      $summarydata['feedback'] = array(
 240          'title'   => get_string('feedback', 'quiz'),
 241          'content' => $feedback,
 242      );
 243  }
 244  
 245  // Summary table end. ==============================================================================
 246  
 247  if ($showall) {
 248      $slots = $attemptobj->get_slots();
 249      $lastpage = true;
 250  } else {
 251      $slots = $attemptobj->get_slots($page);
 252      $lastpage = $attemptobj->is_last_page($page);
 253  }
 254  
 255  $output = $PAGE->get_renderer('mod_quiz');
 256  
 257  // Arrange for the navigation to be displayed.
 258  $navbc = $attemptobj->get_navigation_panel($output, 'quiz_review_nav_panel', $page, $showall);
 259  $regions = $PAGE->blocks->get_regions();
 260  $PAGE->blocks->add_fake_block($navbc, reset($regions));
 261  
 262  echo $output->review_page($attemptobj, $slots, $page, $showall, $lastpage, $options, $summarydata);
 263  
 264  // Trigger an event for this review.
 265  $attemptobj->fire_attempt_reviewed_event();