[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 report_questioninstances report viewed event.
  19   *
  20   * @package    report_questioninstances
  21   * @copyright  2014 Petr Skoda
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace report_questioninstances\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The report_questioninstances report viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - string requestedqtype: Requested question type.
  35   * }
  36   *
  37   * @package    report_questioninstances
  38   * @since      Moodle 2.7
  39   * @copyright  2014 Petr Skoda
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class report_viewed extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       *
  47       * @return void
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52          $this->context = \context_system::instance();
  53      }
  54  
  55      /**
  56       * Return localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventreportviewed', 'report_questioninstances');
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' viewed the question instances report.";
  71      }
  72  
  73      /**
  74       * Return the legacy event log data.
  75       *
  76       * @return array
  77       */
  78      protected function get_legacy_logdata() {
  79          $requestedqtype = $this->other['requestedqtype'];
  80          return array(SITEID, "admin", "report questioninstances", "report/questioninstances/index.php?qtype=$requestedqtype", $requestedqtype);
  81      }
  82  
  83      /**
  84       * Returns relevant URL.
  85       *
  86       * @return \moodle_url
  87       */
  88      public function get_url() {
  89          return new \moodle_url('/report/questioninstances/index.php', array('qtype' => $this->other['requestedqtype']));
  90      }
  91  
  92      /**
  93       * Custom validation.
  94       *
  95       * @throws \coding_exception
  96       */
  97      protected function validate_data() {
  98          parent::validate_data();
  99          if (!isset($this->other['requestedqtype'])) {
 100              throw new \coding_exception('The \'requestedqtype\' value must be set in other.');
 101          }
 102      }
 103  
 104      public static function get_other_mapping() {
 105          // Nothing to map.
 106          return false;
 107      }
 108  }
 109