[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 assessable uploaded event.
  19   *
  20   * @package    mod_forum
  21   * @copyright  2013 Frédéric Massart
  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 assessable uploaded event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int discussionid: id of discussion.
  36   *      - string triggeredfrom: name of the function from where event was triggered.
  37   * }
  38   *
  39   * @package    mod_forum
  40   * @since      Moodle 2.6
  41   * @copyright  2013 Frédéric Massart
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class assessable_uploaded extends \core\event\assessable_uploaded {
  45  
  46      /**
  47       * Returns description of what happened.
  48       *
  49       * @return string
  50       */
  51      public function get_description() {
  52          return "The user with id '$this->userid' has posted content in the forum post with id '$this->objectid' " .
  53              "in the discussion '{$this->other['discussionid']}' located in the forum with course module id " .
  54              "'$this->contextinstanceid'.";
  55      }
  56  
  57      /**
  58       * Legacy event data if get_legacy_eventname() is not empty.
  59       *
  60       * @return \stdClass
  61       */
  62      protected function get_legacy_eventdata() {
  63          $eventdata = new \stdClass();
  64          $eventdata->modulename   = 'forum';
  65          $eventdata->name         = $this->other['triggeredfrom'];
  66          $eventdata->cmid         = $this->contextinstanceid;
  67          $eventdata->itemid       = $this->objectid;
  68          $eventdata->courseid     = $this->courseid;
  69          $eventdata->userid       = $this->userid;
  70          $eventdata->content      = $this->other['content'];
  71          if ($this->other['pathnamehashes']) {
  72              $eventdata->pathnamehashes = $this->other['pathnamehashes'];
  73          }
  74          return $eventdata;
  75      }
  76  
  77      /**
  78       * Return the legacy event name.
  79       *
  80       * @return string
  81       */
  82      public static function get_legacy_eventname() {
  83          return 'assessable_content_uploaded';
  84      }
  85  
  86      /**
  87       * Return localised event name.
  88       *
  89       * @return string
  90       */
  91      public static function get_name() {
  92          return get_string('eventassessableuploaded', 'mod_forum');
  93      }
  94  
  95      /**
  96       * Get URL related to the action.
  97       *
  98       * @return \moodle_url
  99       */
 100      public function get_url() {
 101          return new \moodle_url('/mod/forum/discuss.php', array('d' => $this->other['discussionid'], 'parent' => $this->objectid));
 102      }
 103  
 104      /**
 105       * Init method.
 106       *
 107       * @return void
 108       */
 109      protected function init() {
 110          parent::init();
 111          $this->data['objecttable'] = 'forum_posts';
 112      }
 113  
 114      /**
 115       * Custom validation.
 116       *
 117       * @throws \coding_exception
 118       * @return void
 119       */
 120      protected function validate_data() {
 121          parent::validate_data();
 122  
 123          if (!isset($this->other['discussionid'])) {
 124              throw new \coding_exception('The \'discussionid\' value must be set in other.');
 125          } else if (!isset($this->other['triggeredfrom'])) {
 126              throw new \coding_exception('The \'triggeredfrom\' value must be set in other.');
 127          }
 128      }
 129  
 130      public static function get_objectid_mapping() {
 131          return array('db' => 'forum_posts', 'restore' => 'forum_post');
 132      }
 133  
 134      public static function get_other_mapping() {
 135          $othermapped = array();
 136          $othermapped['discussionid'] = array('db' => 'forum_discussions', 'restore' => 'forum_discussion');
 137  
 138          return $othermapped;
 139      }
 140  }