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 401 and 402] [Versions 401 and 403]

   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   * The mod_quiz attempt regraded event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2020 Russell Boyatt <russell.boyatt@warwick.ac.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_quiz\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_quiz attempt regraded event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int quizid: the id of the quiz.
  35   * }
  36   *
  37   * @package    mod_quiz
  38   * @copyright  2020 Russell Boyatt <russell.boyatt@warwick.ac.uk>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class attempt_regraded extends \core\event\base {
  42  
  43      /**
  44       * Init method.
  45       */
  46      protected function init() {
  47          $this->data['objecttable'] = 'quiz_attempts';
  48          $this->data['crud'] = 'u';
  49          $this->data['edulevel'] = self::LEVEL_TEACHING;
  50      }
  51  
  52      /**
  53       * Returns localised general event name.
  54       *
  55       * @return string
  56       */
  57      public static function get_name() {
  58          return get_string('eventquizattemptregraded', 'mod_quiz');
  59      }
  60  
  61      /**
  62       * Returns description of what happened.
  63       *
  64       * @return string
  65       */
  66      public function get_description() {
  67          return "The user with id '$this->userid' regraded quiz attempt with id '$this->objectid' by user " .
  68            "with id '$this->relateduserid' for the quiz with course module id '$this->contextinstanceid'.";
  69      }
  70  
  71      /**
  72       * Returns relevant URL.
  73       *
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          return new \moodle_url('/mod/quiz/review.php', array('attempt' => $this->objectid));
  78      }
  79  
  80      /**
  81       * Custom validation.
  82       *
  83       * @throws \coding_exception
  84       * @return void
  85       */
  86      protected function validate_data() {
  87          parent::validate_data();
  88  
  89          if (!isset($this->relateduserid)) {
  90              throw new \coding_exception('The \'relateduserid\' must be set.');
  91          }
  92  
  93          if (!isset($this->userid)) {
  94              throw new \coding_exception('The \'userid\' must be set.');
  95          }
  96  
  97          if (!isset($this->other['quizid'])) {
  98              throw new \coding_exception('The \'quizid\' value must be set in other.');
  99          }
 100      }
 101  
 102      /**
 103       * Get mapping to objects
 104       *
 105       * @return array Array of mappings
 106       */
 107      public static function get_objectid_mapping() {
 108          return array('db' => 'quiz_attempts', 'restore' => 'quiz_attempt');
 109      }
 110  
 111      /**
 112       * Retrieve other mapping detail for the event.
 113       *
 114       * @return array Array of array mappings
 115       */
 116      public static function get_other_mapping() {
 117          $othermapped = array();
 118          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 119  
 120          return $othermapped;
 121      }
 122  }