[Summary view]

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