Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

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

   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      throw new \moodle_exception('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->activityheader->set_attrs([
  57      "hidecompletion" => true,
  58      "description" => ""
  59  ]);
  60  
  61  $PAGE->navbar->add(get_string('assessingsubmission', 'workshop'));
  62  $PAGE->set_secondary_active_tab('modulepage');
  63  
  64  $cansetassessmentweight = has_capability('mod/workshop:allocate', $workshop->context);
  65  $canoverridegrades      = has_capability('mod/workshop:overridegrades', $workshop->context);
  66  $isreviewer             = ($USER->id == $assessment->reviewerid);
  67  
  68  $workshop->check_view_assessment($assessment, $submission);
  69  
  70  // only the reviewer is allowed to modify the assessment
  71  if ($isreviewer and $workshop->assessing_allowed($USER->id)) {
  72      $assessmenteditable = true;
  73  } else {
  74      $assessmenteditable = false;
  75  }
  76  
  77  // check that all required examples have been assessed by the user
  78  if ($assessmenteditable) {
  79  
  80      list($assessed, $notice) = $workshop->check_examples_assessed_before_assessment($assessment->reviewerid);
  81      if (!$assessed) {
  82          echo $output->header();
  83          notice(get_string($notice, 'workshop'), new moodle_url('/mod/workshop/view.php', array('id' => $cm->id)));
  84          echo $output->footer();
  85          exit;
  86      }
  87  }
  88  
  89  // load the grading strategy logic
  90  $strategy = $workshop->grading_strategy_instance();
  91  
  92  if (is_null($assessment->grade) and !$assessmenteditable) {
  93      $mform = null;
  94  } else {
  95      // Are there any other pending assessments to do but this one?
  96      if ($assessmenteditable) {
  97          $pending = $workshop->get_pending_assessments_by_reviewer($assessment->reviewerid, $assessment->id);
  98      } else {
  99          $pending = array();
 100      }
 101      // load the assessment form and process the submitted data eventually
 102      $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, $assessmenteditable,
 103                                          array('editableweight' => $cansetassessmentweight, 'pending' => !empty($pending)));
 104  
 105      // Set data managed by the workshop core, subplugins set their own data themselves.
 106      $currentdata = (object)array(
 107          'weight' => $assessment->weight,
 108          'feedbackauthor' => $assessment->feedbackauthor,
 109          'feedbackauthorformat' => $assessment->feedbackauthorformat,
 110      );
 111      if ($assessmenteditable and $workshop->overallfeedbackmode) {
 112          $currentdata = file_prepare_standard_editor($currentdata, 'feedbackauthor', $workshop->overall_feedback_content_options(),
 113              $workshop->context, 'mod_workshop', 'overallfeedback_content', $assessment->id);
 114          if ($workshop->overallfeedbackfiles) {
 115              $currentdata = file_prepare_standard_filemanager($currentdata, 'feedbackauthorattachment',
 116                  $workshop->overall_feedback_attachment_options(), $workshop->context, 'mod_workshop', 'overallfeedback_attachment',
 117                  $assessment->id);
 118          }
 119      }
 120      $mform->set_data($currentdata);
 121  
 122      if ($mform->is_cancelled()) {
 123          redirect($workshop->view_url());
 124      } elseif ($assessmenteditable and ($data = $mform->get_data())) {
 125  
 126          // Add or update assessment.
 127          $rawgrade = $workshop->edit_assessment($assessment, $submission, $data, $strategy);
 128  
 129          // And finally redirect the user's browser.
 130          if (!is_null($rawgrade) and isset($data->saveandclose)) {
 131              redirect($workshop->view_url());
 132          } else if (!is_null($rawgrade) and isset($data->saveandshownext)) {
 133              $next = reset($pending);
 134              if (!empty($next)) {
 135                  redirect($workshop->assess_url($next->id));
 136              } else {
 137                  redirect($PAGE->url); // This should never happen but just in case...
 138              }
 139          } else {
 140              // either it is not possible to calculate the $rawgrade
 141              // or the reviewer has chosen "Save and continue"
 142              redirect($PAGE->url);
 143          }
 144      }
 145  }
 146  
 147  // load the form to override gradinggrade and/or set weight and process the submitted data eventually
 148  if ($canoverridegrades or $cansetassessmentweight) {
 149      $options = array(
 150          'editable' => true,
 151          'editableweight' => $cansetassessmentweight,
 152          'overridablegradinggrade' => $canoverridegrades);
 153      $feedbackform = $workshop->get_feedbackreviewer_form($PAGE->url, $assessment, $options);
 154      if ($data = $feedbackform->get_data()) {
 155          $workshop->evaluate_assessment($assessment, $data, $cansetassessmentweight, $canoverridegrades);
 156          $workshop->aggregate_grading_grades();
 157          redirect($workshop->view_url());
 158      }
 159  }
 160  
 161  // output starts here
 162  $output = $PAGE->get_renderer('mod_workshop');      // workshop renderer
 163  echo $output->header();
 164  echo $output->heading(get_string('assessedsubmission', 'workshop'), 3);
 165  
 166  $submission = $workshop->get_submission_by_id($submission->id);     // reload so can be passed to the renderer
 167  echo $output->render($workshop->prepare_submission($submission, has_capability('mod/workshop:viewauthornames', $workshop->context)));
 168  
 169  // show instructions for assessing as they may contain important information
 170  // for evaluating the assessment
 171  if (trim($workshop->instructreviewers)) {
 172      $instructions = file_rewrite_pluginfile_urls($workshop->instructreviewers, 'pluginfile.php', $PAGE->context->id,
 173          'mod_workshop', 'instructreviewers', null, workshop::instruction_editors_options($PAGE->context));
 174      print_collapsible_region_start('', 'workshop-viewlet-instructreviewers', get_string('instructreviewers', 'workshop'),
 175              'workshop-viewlet-instructreviewers-collapsed');
 176      echo $output->box(format_text($instructions, $workshop->instructreviewersformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 177      print_collapsible_region_end();
 178  }
 179  
 180  // extend the current assessment record with user details
 181  $assessment = $workshop->get_assessment_by_id($assessment->id);
 182  
 183  if ($isreviewer) {
 184      $options    = array(
 185          'showreviewer'  => true,
 186          'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 187          'showform'      => $assessmenteditable or !is_null($assessment->grade),
 188          'showweight'    => true,
 189      );
 190      $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 191      $assessment->title = get_string('assessmentbyyourself', 'workshop');
 192      echo $output->render($assessment);
 193  
 194  } else {
 195      $options    = array(
 196          'showreviewer'  => has_capability('mod/workshop:viewreviewernames', $workshop->context),
 197          'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 198          'showform'      => $assessmenteditable or !is_null($assessment->grade),
 199          'showweight'    => true,
 200      );
 201      $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 202      echo $output->render($assessment);
 203  }
 204  
 205  if (!$assessmenteditable and $canoverridegrades) {
 206      $feedbackform->display();
 207  }
 208  
 209  echo $output->footer();