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