[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_stats report viewed event.
  19   *
  20   * @package    report_stats
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace report_stats\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The report_stats report viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - int report: (optional) Report type.
  35   *      - int time: (optional) Time from which report is viewed.
  36   *      - int mode: (optional) Report mode.
  37   * }
  38   *
  39   * @package    report_stats
  40   * @since      Moodle 2.7
  41   * @copyright  2013 Ankit Agarwal
  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', 'report_stats');
  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 statistics report for the course with id '$this->courseid'.";
  72      }
  73  
  74      /**
  75       * Return the legacy event log data.
  76       *
  77       * @return array
  78       */
  79      protected function get_legacy_logdata() {
  80          return array($this->courseid, "course", "report stats", "report/stats/index.php?course=$this->courseid", $this->courseid);
  81      }
  82  
  83      /**
  84       * Returns relevant URL.
  85       *
  86       * @return \moodle_url
  87       */
  88      public function get_url() {
  89          return new \moodle_url('/report/stats/index.php', array('id' => $this->courseid, 'mode' => $this->other['mode'],
  90                  'report' => $this->other['report']));
  91      }
  92  
  93      /**
  94       * Custom validation.
  95       *
  96       * @throws \coding_exception
  97       * @return void
  98       */
  99      protected function validate_data() {
 100          parent::validate_data();
 101          if (!isset($this->other['report'])) {
 102              throw new \coding_exception('The \'report\' value must be set in other.');
 103          }
 104  
 105          if (!isset($this->other['time'])) {
 106              throw new \coding_exception('The \'time\' value must be set in other.');
 107          }
 108  
 109          if (!isset($this->other['mode'])) {
 110              throw new \coding_exception('The \'mode\' value must be set in other.');
 111          }
 112  
 113          if (!isset($this->relateduserid)) {
 114              throw new \coding_exception('The \'relateduserid\' must be set.');
 115          }
 116      }
 117  
 118      public static function get_other_mapping() {
 119          // Nothing to map.
 120          return array();
 121      }
 122  }
 123