[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 read tracking enabled 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 read tracking enabled event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int forumid: The id of the forum which readtracking has been enabled on.
  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 readtracking_enabled extends \core\event\base {
  44      /**
  45       * Init method.
  46       *
  47       * @return void
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'c';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52      }
  53  
  54      /**
  55       * Returns description of what happened.
  56       *
  57       * @return string
  58       */
  59      public function get_description() {
  60          return "The user with id '$this->userid' has enabled read tracking for the user with id '$this->relateduserid' " .
  61              "in the forum with course module id '$this->contextinstanceid'.";
  62      }
  63  
  64      /**
  65       * Return localised event name.
  66       *
  67       * @return string
  68       */
  69      public static function get_name() {
  70          return get_string('eventreadtrackingenabled', 'mod_forum');
  71      }
  72  
  73      /**
  74       * Get URL related to the action
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          return new \moodle_url('/mod/forum/view.php', array('f' => $this->other['forumid']));
  80      }
  81  
  82      /**
  83       * Return the legacy event log data.
  84       *
  85       * @return array|null
  86       */
  87      protected function get_legacy_logdata() {
  88          return array($this->courseid, 'forum', 'start tracking', 'view.php?f=' . $this->other['forumid'],
  89              $this->other['forumid'], $this->contextinstanceid);
  90      }
  91  
  92      /**
  93       * Custom validation.
  94       *
  95       * @throws \coding_exception
  96       * @return void
  97       */
  98      protected function validate_data() {
  99          parent::validate_data();
 100  
 101          if (!isset($this->relateduserid)) {
 102              throw new \coding_exception('The \'relateduserid\' must be set.');
 103          }
 104  
 105          if (!isset($this->other['forumid'])) {
 106              throw new \coding_exception('The \'forumid\' value must be set in other.');
 107          }
 108  
 109          if ($this->contextlevel != CONTEXT_MODULE) {
 110              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 111          }
 112      }
 113  
 114      public static function get_other_mapping() {
 115          $othermapped = array();
 116          $othermapped['forumid'] = array('db' => 'forum', 'restore' => 'forum');
 117  
 118          return $othermapped;
 119      }
 120  }