Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

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

   1  <?php
   2  
   3  // This file is part of Moodle - http://moodle.org/
   4  //
   5  // Moodle is free software: you can redistribute it and/or modify
   6  // it under the terms of the GNU General Public License as published by
   7  // the Free Software Foundation, either version 3 of the License, or
   8  // (at your option) any later version.
   9  //
  10  // Moodle is distributed in the hope that it will be useful,
  11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  // GNU General Public License for more details.
  14  //
  15  // You should have received a copy of the GNU General Public License
  16  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17  
  18  /**
  19   * Assess a submission or view the single assessment
  20   *
  21   * Assessment id parameter must be passed. The script displays the submission and
  22   * the assessment form. If the current user is the reviewer and the assessing is
  23   * allowed, new assessment can be saved.
  24   * If the assessing is not allowed (for example, the assessment period is over
  25   * or the current user is eg a teacher), the assessment form is opened
  26   * in a non-editable mode.
  27   * The capability 'mod/workshop:peerassess' is intentionally not checked here.
  28   * The user is considered as a reviewer if the corresponding assessment record
  29   * has been prepared for him/her (during the allocation). So even a user without the
  30   * peerassess capability (like a 'teacher', for example) can become a reviewer.
  31   *
  32   * @package    mod_workshop
  33   * @copyright  2009 David Mudrak <david.mudrak@gmail.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  
  37  require(__DIR__.'/../../config.php');
  38  require_once (__DIR__.'/locallib.php');
  39  
  40  $asid       = required_param('asid', PARAM_INT);  // assessment id
  41  $assessment = $DB->get_record('workshop_assessments', array('id' => $asid), '*', MUST_EXIST);
  42  $submission = $DB->get_record('workshop_submissions', array('id' => $assessment->submissionid, 'example' => 0), '*', MUST_EXIST);
  43  $workshop   = $DB->get_record('workshop', array('id' => $submission->workshopid), '*', MUST_EXIST);
  44  $course     = $DB->get_record('course', array('id' => $workshop->course), '*', MUST_EXIST);
  45  $cm         = get_coursemodule_from_instance('workshop', $workshop->id, $course->id, false, MUST_EXIST);
  46  
  47  require_login($course, false, $cm);
  48  if (isguestuser()) {
  49      print_error('guestsarenotallowed');
  50  }
  51  $workshop = new workshop($workshop, $cm, $course);
  52  
  53  $PAGE->set_url($workshop->assess_url($assessment->id));
  54  $PAGE->set_title($workshop->name);
  55  $PAGE->set_heading($course->fullname);
  56  $PAGE->navbar->add(get_string('assessingsubmission', 'workshop'));
  57  
  58  $cansetassessmentweight = has_capability('mod/workshop:allocate', $workshop->context);
  59  $canoverridegrades      = has_capability('mod/workshop:overridegrades', $workshop->context);
  60  $isreviewer             = ($USER->id == $assessment->reviewerid);
  61  
  62  $workshop->check_view_assessment($assessment, $submission);
  63  
  64  // only the reviewer is allowed to modify the assessment
  65  if ($isreviewer and $workshop->assessing_allowed($USER->id)) {
  66      $assessmenteditable = true;
  67  } else {
  68      $assessmenteditable = false;
  69  }
  70  
  71  // check that all required examples have been assessed by the user
  72  if ($assessmenteditable) {
  73  
  74      list($assessed, $notice) = $workshop->check_examples_assessed_before_assessment($assessment->reviewerid);
  75      if (!$assessed) {
  76          echo $output->header();
  77          echo $output->heading(format_string($workshop->name));
  78          notice(get_string($notice, 'workshop'), new moodle_url('/mod/workshop/view.php', array('id' => $cm->id)));
  79          echo $output->footer();
  80          exit;
  81      }
  82  }
  83  
  84  // load the grading strategy logic
  85  $strategy = $workshop->grading_strategy_instance();
  86  
  87  if (is_null($assessment->grade) and !$assessmenteditable) {
  88      $mform = null;
  89  } else {
  90      // Are there any other pending assessments to do but this one?
  91      if ($assessmenteditable) {
  92          $pending = $workshop->get_pending_assessments_by_reviewer($assessment->reviewerid, $assessment->id);
  93      } else {
  94          $pending = array();
  95      }
  96      // load the assessment form and process the submitted data eventually
  97      $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, $assessmenteditable,
  98                                          array('editableweight' => $cansetassessmentweight, 'pending' => !empty($pending)));
  99  
 100      // Set data managed by the workshop core, subplugins set their own data themselves.
 101      $currentdata = (object)array(
 102          'weight' => $assessment->weight,
 103          'feedbackauthor' => $assessment->feedbackauthor,
 104          'feedbackauthorformat' => $assessment->feedbackauthorformat,
 105      );
 106      if ($assessmenteditable and $workshop->overallfeedbackmode) {
 107          $currentdata = file_prepare_standard_editor($currentdata, 'feedbackauthor', $workshop->overall_feedback_content_options(),
 108              $workshop->context, 'mod_workshop', 'overallfeedback_content', $assessment->id);
 109          if ($workshop->overallfeedbackfiles) {
 110              $currentdata = file_prepare_standard_filemanager($currentdata, 'feedbackauthorattachment',
 111                  $workshop->overall_feedback_attachment_options(), $workshop->context, 'mod_workshop', 'overallfeedback_attachment',
 112                  $assessment->id);
 113          }
 114      }
 115      $mform->set_data($currentdata);
 116  
 117      if ($mform->is_cancelled()) {
 118          redirect($workshop->view_url());
 119      } elseif ($assessmenteditable and ($data = $mform->get_data())) {
 120  
 121          // Add or update assessment.
 122          $rawgrade = $workshop->edit_assessment($assessment, $submission, $data, $strategy);
 123  
 124          // And finally redirect the user's browser.
 125          if (!is_null($rawgrade) and isset($data->saveandclose)) {
 126              redirect($workshop->view_url());
 127          } else if (!is_null($rawgrade) and isset($data->saveandshownext)) {
 128              $next = reset($pending);
 129              if (!empty($next)) {
 130                  redirect($workshop->assess_url($next->id));
 131              } else {
 132                  redirect($PAGE->url); // This should never happen but just in case...
 133              }
 134          } else {
 135              // either it is not possible to calculate the $rawgrade
 136              // or the reviewer has chosen "Save and continue"
 137              redirect($PAGE->url);
 138          }
 139      }
 140  }
 141  
 142  // load the form to override gradinggrade and/or set weight and process the submitted data eventually
 143  if ($canoverridegrades or $cansetassessmentweight) {
 144      $options = array(
 145          'editable' => true,
 146          'editableweight' => $cansetassessmentweight,
 147          'overridablegradinggrade' => $canoverridegrades);
 148      $feedbackform = $workshop->get_feedbackreviewer_form($PAGE->url, $assessment, $options);
 149      if ($data = $feedbackform->get_data()) {
 150          $workshop->evaluate_assessment($assessment, $data, $cansetassessmentweight, $canoverridegrades);
 151          redirect($workshop->view_url());
 152      }
 153  }
 154  
 155  // output starts here
 156  $output = $PAGE->get_renderer('mod_workshop');      // workshop renderer
 157  echo $output->header();
 158  echo $output->heading(format_string($workshop->name));
 159  echo $output->heading(get_string('assessedsubmission', 'workshop'), 3);
 160  
 161  $submission = $workshop->get_submission_by_id($submission->id);     // reload so can be passed to the renderer
 162  echo $output->render($workshop->prepare_submission($submission, has_capability('mod/workshop:viewauthornames', $workshop->context)));
 163  
 164  // show instructions for assessing as they may contain important information
 165  // for evaluating the assessment
 166  if (trim($workshop->instructreviewers)) {
 167      $instructions = file_rewrite_pluginfile_urls($workshop->instructreviewers, 'pluginfile.php', $PAGE->context->id,
 168          'mod_workshop', 'instructreviewers', null, workshop::instruction_editors_options($PAGE->context));
 169      print_collapsible_region_start('', 'workshop-viewlet-instructreviewers', get_string('instructreviewers', 'workshop'),
 170              'workshop-viewlet-instructreviewers-collapsed');
 171      echo $output->box(format_text($instructions, $workshop->instructreviewersformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 172      print_collapsible_region_end();
 173  }
 174  
 175  // extend the current assessment record with user details
 176  $assessment = $workshop->get_assessment_by_id($assessment->id);
 177  
 178  if ($isreviewer) {
 179      $options    = array(
 180          'showreviewer'  => true,
 181          'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 182          'showform'      => $assessmenteditable or !is_null($assessment->grade),
 183          'showweight'    => true,
 184      );
 185      $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 186      $assessment->title = get_string('assessmentbyyourself', 'workshop');
 187      echo $output->render($assessment);
 188  
 189  } else {
 190      $options    = array(
 191          'showreviewer'  => has_capability('mod/workshop:viewreviewernames', $workshop->context),
 192          'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 193          'showform'      => $assessmenteditable or !is_null($assessment->grade),
 194          'showweight'    => true,
 195      );
 196      $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 197      echo $output->render($assessment);
 198  }
 199  
 200  if (!$assessmenteditable and $canoverridegrades) {
 201      $feedbackform->display();
 202  }
 203  
 204  echo $output->footer();