[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_outline outline report viewed event.
  19   *
  20   * @package    report_outline
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace report_outline\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The report_outline outline report viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - string mode: display mode.
  35   * }
  36   *
  37   * @package    report_outline
  38   * @since      Moodle 2.7
  39   * @copyright  2013 Ankit Agarwal
  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_TEACHING;
  52      }
  53  
  54      /**
  55       * Return localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventoutlinereportviewed', 'report_outline');
  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' viewed the outline report for the user with id '$this->relateduserid' " .
  70              "for the course with id '$this->courseid'.";
  71      }
  72  
  73      /**
  74       * Return the legacy event log data.
  75       *
  76       * @return array
  77       */
  78      protected function get_legacy_logdata() {
  79          $url = "report/outline/user.php?id=". $this->userid . "&course=" . $this->courseid . "&mode=" . $this->other['mode'];
  80          return array($this->courseid, 'course', 'report outline', $url, $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/outline/user.php', array('course' => $this->courseid, 'id' => $this->relateduserid,
  90                  'mode' => $this->other['mode']));
  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 (empty($this->other['mode'])) {
 102              throw new \coding_exception('The \'mode\' value must be set in other.');
 103          }
 104          if (empty($this->relateduserid)) {
 105              throw new \coding_exception('The \'relateduserid\' must be set.');
 106          }
 107      }
 108  
 109      public static function get_other_mapping() {
 110          // Nothing to map.
 111          return false;
 112      }
 113  
 114  }