[Summary view]

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