[Summary view]

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