[Summary view]

   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_subscription deleted event.
  19   *
  20   * @package    mod_forum
  21   * @copyright  2014 Andrew Nicols <andrew@nicols.co.uk>
  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_subscription deleted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int forumid: The id of the forum which the discussion is in.
  36   *      - int discussion: The id of the discussion which has been unsubscribed from.
  37   * }
  38   *
  39   * @package    mod_forum
  40   * @since      Moodle 2.8
  41   * @copyright  2014 Andrew Nicols <andrew@nicols.co.uk>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class discussion_subscription_deleted extends \core\event\base {
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->data['crud'] = 'd';
  52          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  53          $this->data['objecttable'] = 'forum_discussion_subs';
  54      }
  55  
  56      /**
  57       * Returns description of what happened.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62          return "The user with id '$this->userid' unsubscribed the user with id '$this->relateduserid' from the discussion " .
  63              " with id '{$this->other['discussion']}' in the forum with the course module id '$this->contextinstanceid'.";
  64      }
  65  
  66      /**
  67       * Return localised event name.
  68       *
  69       * @return string
  70       */
  71      public static function get_name() {
  72          return get_string('eventdiscussionsubscriptiondeleted', 'mod_forum');
  73      }
  74  
  75      /**
  76       * Get URL related to the action.
  77       *
  78       * @return \moodle_url
  79       */
  80      public function get_url() {
  81          return new \moodle_url('/mod/forum/subscribe.php', array(
  82              'id' => $this->other['forumid'],
  83              'd' => $this->other['discussion'],
  84          ));
  85      }
  86  
  87      /**
  88       * Custom validation.
  89       *
  90       * @throws \coding_exception
  91       * @return void
  92       */
  93      protected function validate_data() {
  94          parent::validate_data();
  95  
  96          if (!isset($this->relateduserid)) {
  97              throw new \coding_exception('The \'relateduserid\' must be set.');
  98          }
  99  
 100          if (!isset($this->other['forumid'])) {
 101              throw new \coding_exception('The \'forumid\' value must be set in other.');
 102          }
 103  
 104          if (!isset($this->other['discussion'])) {
 105              throw new \coding_exception('The \'discussion\' value must be set in other.');
 106          }
 107  
 108          if ($this->contextlevel != CONTEXT_MODULE) {
 109              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 110          }
 111      }
 112  
 113      public static function get_objectid_mapping() {
 114          return array('db' => 'forum_discussion_subs', 'restore' => 'forum_discussion_sub');
 115      }
 116  
 117      public static function get_other_mapping() {
 118          $othermapped = array();
 119          $othermapped['forumid'] = array('db' => 'forum', 'restore' => 'forum');
 120          $othermapped['discussion'] = array('db' => 'forum_discussions', 'restore' => 'forum_discussion');
 121  
 122          return $othermapped;
 123      }
 124  }