[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 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 discussion created event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int forumid: The id of the forum the discussion is in.
  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 discussion_created 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_PARTICIPATING;
  52          $this->data['objecttable'] = 'forum_discussions';
  53      }
  54  
  55      /**
  56       * Returns description of what happened.
  57       *
  58       * @return string
  59       */
  60      public function get_description() {
  61          return "The user with id '$this->userid' has created the discussion with id '$this->objectid' in the forum " .
  62              "with course module id '$this->contextinstanceid'.";
  63      }
  64  
  65      /**
  66       * Return localised event name.
  67       *
  68       * @return string
  69       */
  70      public static function get_name() {
  71          return get_string('eventdiscussioncreated', 'mod_forum');
  72      }
  73  
  74      /**
  75       * Get URL related to the action
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/mod/forum/discuss.php', array('d' => $this->objectid));
  81      }
  82  
  83      /**
  84       * Return the legacy event log data.
  85       *
  86       * @return array|null
  87       */
  88      protected function get_legacy_logdata() {
  89  
  90          // The legacy log table expects a relative path to /mod/forum/.
  91          $logurl = substr($this->get_url()->out_as_local_url(), strlen('/mod/forum/'));
  92  
  93          return array($this->courseid, 'forum', 'add discussion', $logurl, $this->objectid, $this->contextinstanceid);
  94      }
  95  
  96      /**
  97       * Custom validation.
  98       *
  99       * @throws \coding_exception
 100       * @return void
 101       */
 102      protected function validate_data() {
 103          parent::validate_data();
 104          if (!isset($this->other['forumid'])) {
 105              throw new \coding_exception('The \'forumid\' 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_discussions', 'restore' => 'forum_discussion');
 115      }
 116  
 117      public static function get_other_mapping() {
 118          $othermapped = array();
 119          $othermapped['forumid'] = array('db' => 'forum', 'restore' => 'forum');
 120  
 121          return $othermapped;
 122      }
 123  }