[Summary view]

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