[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 discussion 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 discussion viewed event class.
  31   *
  32   * @package    mod_forum
  33   * @since      Moodle 2.7
  34   * @copyright  2014 Dan Poltawski <dan@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class discussion_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_PARTICIPATING;
  47          $this->data['objecttable'] = 'forum_discussions';
  48      }
  49  
  50      /**
  51       * Returns description of what happened.
  52       *
  53       * @return string
  54       */
  55      public function get_description() {
  56          return "The user with id '$this->userid' has viewed the discussion with id '$this->objectid' in the forum " .
  57              "with course module id '$this->contextinstanceid'.";
  58      }
  59  
  60      /**
  61       * Return localised event name.
  62       *
  63       * @return string
  64       */
  65      public static function get_name() {
  66          return get_string('eventdiscussionviewed', 'mod_forum');
  67      }
  68  
  69      /**
  70       * Get URL related to the action
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          return new \moodle_url('/mod/forum/discuss.php', array('d' => $this->objectid));
  76      }
  77  
  78      /**
  79       * Return the legacy event log data.
  80       *
  81       * @return array|null
  82       */
  83      protected function get_legacy_logdata() {
  84          return array($this->courseid, 'forum', 'view discussion', 'discuss.php?d=' . $this->objectid,
  85              $this->objectid, $this->contextinstanceid);
  86      }
  87  
  88      /**
  89       * Custom validation.
  90       *
  91       * @throws \coding_exception
  92       * @return void
  93       */
  94      protected function validate_data() {
  95          parent::validate_data();
  96  
  97          if ($this->contextlevel != CONTEXT_MODULE) {
  98              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
  99          }
 100      }
 101  
 102      public static function get_objectid_mapping() {
 103          return array('db' => 'forum_discussions', 'restore' => 'forum_discussion');
 104      }
 105  }
 106