[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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_chat message sent event.
  19   *
  20   * @package    mod_chat
  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_chat\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_chat message sent event class.
  30   *
  31   * @package    mod_chat
  32   * @since      Moodle 2.6
  33   * @copyright  2013 Frédéric Massart
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class message_sent extends \core\event\base {
  37  
  38      /**
  39       * Returns description of what happened.
  40       *
  41       * @return string
  42       */
  43      public function get_description() {
  44          return "The user with id '$this->relateduserid' has sent a message in the chat with course module id
  45              '$this->contextinstanceid'.";
  46      }
  47  
  48      /**
  49       * Return legacy log data.
  50       *
  51       * @return array
  52       */
  53      protected function get_legacy_logdata() {
  54          $message = $this->get_record_snapshot('chat_messages', $this->objectid);
  55          return array($this->courseid, 'chat', 'talk', 'view.php?id=' . $this->contextinstanceid,
  56              $message->chatid, $this->contextinstanceid, $this->relateduserid);
  57      }
  58  
  59      /**
  60       * Return localised event name.
  61       *
  62       * @return string
  63       */
  64      public static function get_name() {
  65          return get_string('eventmessagesent', 'mod_chat');
  66      }
  67  
  68      /**
  69       * Get URL related to the action
  70       *
  71       * @return \moodle_url
  72       */
  73      public function get_url() {
  74          return new \moodle_url('/mod/chat/view.php', array('id' => $this->contextinstanceid));
  75      }
  76  
  77      /**
  78       * Init method.
  79       *
  80       * @return void
  81       */
  82      protected function init() {
  83          $this->data['crud'] = 'c';
  84          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  85          $this->data['objecttable'] = 'chat_messages';
  86      }
  87  
  88      /**
  89       * Custom validation.
  90       *
  91       * @throws \coding_exception
  92       * @return void
  93       */
  94      protected function validate_data() {
  95          parent::validate_data();
  96          if (!isset($this->relateduserid)) {
  97              throw new \coding_exception('The \'relateduserid\' must be set.');
  98          }
  99      }
 100  
 101      public static function get_objectid_mapping() {
 102          return array('db' => 'chat_messages', 'restore' => 'chat_message');
 103      }
 104  }