[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 moved 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 moved event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int fromforumid: The id of the forum the discussion is being moved from.
  36   *      - int toforumid: The id of the forum the discussion is being moved to.
  37   * }
  38   *
  39   * @package    mod_forum
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Dan Poltawski <dan@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class discussion_moved extends \core\event\base {
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->data['crud'] = 'u';
  52          $this->data['edulevel'] = self::LEVEL_OTHER;
  53          $this->data['objecttable'] = 'forum_discussions';
  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' has moved the discussion with id '$this->objectid' from the " .
  63              "forum with id '{$this->other['fromforumid']}' to the forum with id '{$this->other['toforumid']}'.";
  64      }
  65  
  66      /**
  67       * Return localised event name.
  68       *
  69       * @return string
  70       */
  71      public static function get_name() {
  72          return get_string('eventdiscussionmoved', '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/discuss.php', array('d' => $this->objectid));
  82      }
  83  
  84      /**
  85       * Return the legacy event log data.
  86       *
  87       * @return array|null
  88       */
  89      protected function get_legacy_logdata() {
  90          return array($this->courseid, 'forum', 'move discussion', 'discuss.php?d=' . $this->objectid,
  91              $this->objectid, $this->contextinstanceid);
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception
  98       * @return void
  99       */
 100      protected function validate_data() {
 101          parent::validate_data();
 102          if (!isset($this->other['fromforumid'])) {
 103              throw new \coding_exception('The \'fromforumid\' value must be set in other.');
 104          }
 105  
 106          if (!isset($this->other['toforumid'])) {
 107              throw new \coding_exception('The \'toforumid\' value must be set in other.');
 108          }
 109  
 110          if ($this->contextlevel != CONTEXT_MODULE) {
 111              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 112          }
 113      }
 114  
 115      public static function get_objectid_mapping() {
 116          return array('db' => 'forum_discussions', 'restore' => 'forum_discussion');
 117      }
 118  
 119      public static function get_other_mapping() {
 120          $othermapped = array();
 121          $othermapped['fromforumid'] = array('db' => 'forum', 'restore' => 'forum');
 122          $othermapped['toforumid'] = array('db' => 'forum', 'restore' => 'forum');
 123  
 124          return $othermapped;
 125      }
 126  }