[Summary view]

Differences Between: [Versions 39 and 402] [Versions 39 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 became overdue event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2013 Adrian Greeve <adrian@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_quiz\event;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * The mod_quiz attempt became overdue event class.
  29   *
  30   * Please note that the name of this event is not following the event naming convention.
  31   * Its name should not be used as a reference for other events to be created.
  32   *
  33   * @property-read array $other {
  34   *      Extra information about event.
  35   *
  36   *      - int submitterid: id of submitter (null when trigged by CLI script).
  37   *      - int quizid: (optional) the id of the quiz.
  38   * }
  39   *
  40   * @package    mod_quiz
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Adrian Greeve <adrian@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class attempt_becameoverdue extends \core\event\base {
  46  
  47      /**
  48       * Init method.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'quiz_attempts';
  52          $this->data['crud'] = 'u';
  53          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  54      }
  55  
  56      /**
  57       * Returns description of what happened.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62          return "The quiz attempt with id '$this->objectid' belonging to the quiz with course module id '$this->contextinstanceid' " .
  63              "for the user with id '$this->relateduserid' became overdue.";
  64      }
  65  
  66      /**
  67       * Returns localised general event name.
  68       *
  69       * @return string
  70       */
  71      public static function get_name() {
  72          return get_string('eventquizattempttimelimitexceeded', 'mod_quiz');
  73      }
  74  
  75      /**
  76       * Does this event replace a legacy event?
  77       *
  78       * @return string legacy event name
  79       */
  80      static public function get_legacy_eventname() {
  81          return 'quiz_attempt_overdue';
  82      }
  83  
  84      /**
  85       * Returns relevant URL.
  86       *
  87       * @return \moodle_url
  88       */
  89      public function get_url() {
  90          return new \moodle_url('/mod/quiz/review.php', array('attempt' => $this->objectid));
  91      }
  92  
  93      /**
  94       * Legacy event data if get_legacy_eventname() is not empty.
  95       *
  96       * @return \stdClass
  97       */
  98      protected function get_legacy_eventdata() {
  99          $attempt = $this->get_record_snapshot('quiz_attempts', $this->objectid);
 100  
 101          $legacyeventdata = new \stdClass();
 102          $legacyeventdata->component = 'mod_quiz';
 103          $legacyeventdata->attemptid = $this->objectid;
 104          $legacyeventdata->timestamp = $attempt->timemodified;
 105          $legacyeventdata->userid = $this->relateduserid;
 106          $legacyeventdata->quizid = $attempt->quiz;
 107          $legacyeventdata->cmid = $this->contextinstanceid;
 108          $legacyeventdata->courseid = $this->courseid;
 109          $legacyeventdata->submitterid = $this->other['submitterid'];
 110  
 111          return $legacyeventdata;
 112      }
 113  
 114      /**
 115       * Custom validation.
 116       *
 117       * @throws \coding_exception
 118       * @return void
 119       */
 120      protected function validate_data() {
 121          parent::validate_data();
 122  
 123          if (!isset($this->relateduserid)) {
 124              throw new \coding_exception('The \'relateduserid\' must be set.');
 125          }
 126  
 127          if (!array_key_exists('submitterid', $this->other)) {
 128              throw new \coding_exception('The \'submitterid\' value must be set in other.');
 129          }
 130      }
 131  
 132      public static function get_objectid_mapping() {
 133          return array('db' => 'quiz_attempts', 'restore' => 'quiz_attempt');
 134      }
 135  
 136      public static function get_other_mapping() {
 137          $othermapped = array();
 138          $othermapped['submitterid'] = array('db' => 'user', 'restore' => 'user');
 139          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 140  
 141          return $othermapped;
 142      }
 143  }