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