[Summary view]

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 report_stats user 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 user report viewed event class.
  30   *
  31   * @package    report_stats
  32   * @since      Moodle 2.7
  33   * @copyright  2013 Ankit Agarwal
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class user_report_viewed extends \core\event\base {
  37  
  38      /**
  39       * Init method.
  40       *
  41       * @return void
  42       */
  43      protected function init() {
  44          $this->data['crud'] = 'r';
  45          $this->data['edulevel'] = self::LEVEL_TEACHING;
  46      }
  47  
  48      /**
  49       * Return localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventuserreportviewed', 'report_stats');
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' viewed the user statistics report for the user with id '$this->relateduserid'.";
  64      }
  65  
  66      /**
  67       * Return the legacy event log data.
  68       *
  69       * @return array
  70       */
  71      protected function get_legacy_logdata() {
  72          $url = 'report/stats/user.php?id=' . $this->relateduserid . '&course=' . $this->courseid;
  73          return (array($this->courseid, 'course', 'report stats', $url, $this->courseid));
  74      }
  75  
  76      /**
  77       * Returns relevant URL.
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          return new \moodle_url('/report/stats/user.php', array('id' => $this->relateduserid, 'course' => $this->courseid));
  83      }
  84  
  85      /**
  86       * Custom validation.
  87       *
  88       * @throws \coding_exception
  89       * @return void
  90       */
  91      protected function validate_data() {
  92          parent::validate_data();
  93          if (empty($this->relateduserid)) {
  94              throw new \coding_exception('The \'relateduserid\' must be set.');
  95          }
  96      }
  97  }
  98