[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 post created 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 post created event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int discussionid: The discussion id the post is part of.
  36   *      - int forumid: The forum id the post is part of.
  37   *      - string forumtype: The type of forum the post is part of.
  38   * }
  39   *
  40   * @package    mod_forum
  41   * @since      Moodle 2.7
  42   * @copyright  2014 Dan Poltawski <dan@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class post_created extends \core\event\base {
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'c';
  53          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  54          $this->data['objecttable'] = 'forum_posts';
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' has created the post with id '$this->objectid' in the discussion with " .
  64              "id '{$this->other['discussionid']}' in the forum with course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Return localised event name.
  69       *
  70       * @return string
  71       */
  72      public static function get_name() {
  73          return get_string('eventpostcreated', 'mod_forum');
  74      }
  75  
  76      /**
  77       * Get URL related to the action
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          if ($this->other['forumtype'] == 'single') {
  83              // Single discussion forums are an exception. We show
  84              // the forum itself since it only has one discussion
  85              // thread.
  86              $url = new \moodle_url('/mod/forum/view.php', array('f' => $this->other['forumid']));
  87          } else {
  88              $url = new \moodle_url('/mod/forum/discuss.php', array('d' => $this->other['discussionid']));
  89          }
  90          $url->set_anchor('p'.$this->objectid);
  91          return $url;
  92      }
  93  
  94      /**
  95       * Return the legacy event log data.
  96       *
  97       * @return array|null
  98       */
  99      protected function get_legacy_logdata() {
 100          // The legacy log table expects a relative path to /mod/forum/.
 101          $logurl = substr($this->get_url()->out_as_local_url(), strlen('/mod/forum/'));
 102  
 103          return array($this->courseid, 'forum', 'add post', $logurl, $this->other['forumid'], $this->contextinstanceid);
 104      }
 105  
 106      /**
 107       * Custom validation.
 108       *
 109       * @throws \coding_exception
 110       * @return void
 111       */
 112      protected function validate_data() {
 113          parent::validate_data();
 114  
 115          if (!isset($this->other['discussionid'])) {
 116              throw new \coding_exception('The \'discussionid\' value must be set in other.');
 117          }
 118  
 119          if (!isset($this->other['forumid'])) {
 120              throw new \coding_exception('The \'forumid\' value must be set in other.');
 121          }
 122  
 123          if (!isset($this->other['forumtype'])) {
 124              throw new \coding_exception('The \'forumtype\' value must be set in other.');
 125          }
 126  
 127          if ($this->contextlevel != CONTEXT_MODULE) {
 128              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 129          }
 130      }
 131  
 132      public static function get_objectid_mapping() {
 133          return array('db' => 'forum_posts', 'restore' => 'forum_post');
 134      }
 135  
 136      public static function get_other_mapping() {
 137          $othermapped = array();
 138          $othermapped['forumid'] = array('db' => 'forum', 'restore' => 'forum');
 139          $othermapped['discussionid'] = array('db' => 'forum_discussions', 'restore' => 'forum_discussion');
 140  
 141          return $othermapped;
 142      }
 143  }