Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

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 report 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 report viewed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int quizid: the id of the quiz.
  36   *      - string reportname: the name of the report.
  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 report_viewed extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'r';
  53          $this->data['edulevel'] = self::LEVEL_TEACHING;
  54      }
  55  
  56      /**
  57       * Return localised event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventreportviewed', 'mod_quiz');
  63      }
  64  
  65      /**
  66       * Returns description of what happened.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' viewed the report '" . s($this->other['reportname']) . "' for the quiz with " .
  72              "course module id '$this->contextinstanceid'.";
  73      }
  74  
  75      /**
  76       * Get URL related to the action.
  77       *
  78       * @return \moodle_url
  79       */
  80      public function get_url() {
  81          return new \moodle_url('/mod/quiz/report.php', array('id' => $this->contextinstanceid,
  82              'mode' => $this->other['reportname']));
  83      }
  84  
  85      /**
  86       * Return the legacy event log data.
  87       *
  88       * @return array
  89       */
  90      protected function get_legacy_logdata() {
  91          return array($this->courseid, 'quiz', 'report', 'report.php?id=' . $this->contextinstanceid . '&mode=' .
  92              $this->other['reportname'], $this->other['quizid'], $this->contextinstanceid);
  93      }
  94  
  95      /**
  96       * Custom validation.
  97       *
  98       * @throws \coding_exception
  99       * @return void
 100       */
 101      protected function validate_data() {
 102          parent::validate_data();
 103  
 104          if (!isset($this->other['quizid'])) {
 105              throw new \coding_exception('The \'quizid\' value must be set in other.');
 106          }
 107  
 108          if (!isset($this->other['reportname'])) {
 109              throw new \coding_exception('The \'reportname\' value must be set in other.');
 110          }
 111      }
 112  
 113      public static function get_other_mapping() {
 114          $othermapped = array();
 115          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 116  
 117          return $othermapped;
 118      }
 119  }