[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 mod_forum user report viewed event.
  19   *
  20   * @package    mod_forum
  21   * @copyright  2014 Dan Poltawski <dan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_forum\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_forum user report viewed event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - string reportmode: The mode the report has been viewed in (posts or discussions).
  36   * }
  37   *
  38   * @package    mod_forum
  39   * @since      Moodle 2.7
  40   * @copyright  2014 Dan Poltawski <dan@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class user_report_viewed extends \core\event\base {
  44  
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->data['crud'] = 'r';
  52          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  53      }
  54  
  55      /**
  56       * Returns description of what happened.
  57       *
  58       * @return string
  59       */
  60      public function get_description() {
  61          return "The user with id '$this->userid' has viewed the user report for the user with id '$this->relateduserid' in " .
  62              "the course with id '$this->courseid' with viewing mode '{$this->other['reportmode']}'.";
  63      }
  64  
  65      /**
  66       * Return localised event name.
  67       *
  68       * @return string
  69       */
  70      public static function get_name() {
  71          return get_string('eventuserreportviewed', 'mod_forum');
  72      }
  73  
  74      /**
  75       * Get URL related to the action
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80  
  81          $url = new \moodle_url('/mod/forum/user.php', array('id' => $this->relateduserid,
  82              'mode' => $this->other['reportmode']));
  83  
  84          if ($this->courseid != SITEID) {
  85              $url->param('course', $this->courseid);
  86          }
  87  
  88          return $url;
  89      }
  90  
  91      /**
  92       * Return the legacy event log data.
  93       *
  94       * @return array|null
  95       */
  96      protected function get_legacy_logdata() {
  97          // The legacy log table expects a relative path to /mod/forum/.
  98          $logurl = substr($this->get_url()->out_as_local_url(), strlen('/mod/forum/'));
  99  
 100          return array($this->courseid, 'forum', 'user report', $logurl, $this->relateduserid);
 101      }
 102  
 103      /**
 104       * Custom validation.
 105       *
 106       * @throws \coding_exception
 107       * @return void
 108       */
 109      protected function validate_data() {
 110          parent::validate_data();
 111          if (!isset($this->relateduserid)) {
 112              throw new \coding_exception('The \'relateduserid\' must be set.');
 113          }
 114          if (!isset($this->other['reportmode'])) {
 115              throw new \coding_exception('The \'reportmode\' value must be set in other.');
 116          }
 117  
 118          switch ($this->contextlevel)
 119          {
 120              case CONTEXT_COURSE:
 121              case CONTEXT_SYSTEM:
 122              case CONTEXT_USER:
 123                  // OK, expected context level.
 124                  break;
 125              default:
 126                  // Unexpected contextlevel.
 127                  throw new \coding_exception('Context level must be either CONTEXT_SYSTEM, CONTEXT_COURSE or CONTEXT_USER.');
 128          }
 129      }
 130  
 131      public static function get_other_mapping() {
 132          return false;
 133      }
 134  }
 135