← Back to branch summary

~ubuntu-branches/ubuntu/utopic/moodle/utopic

« back to all changes in this revision

Viewing changes to mod/chat/classes/event/message_sent.php

  • Committer: Package Import Robot
  • Author(s): Thijs Kinkhorst
  • Date: 2014-05-12 16:10:38 UTC
  • mfrom: (36.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20140512161038-puyqf65k4e0s8ytz
Tags: 2.6.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mod/chat/classes/event/message_sent.php
 
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
 * 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
 * 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 $this->relateduserid has sent a message in a chat.";
 
45
    }
 
46
 
 
47
    /**
 
48
     * Return legacy log data.
 
49
     *
 
50
     * @return array
 
51
     */
 
52
    protected function get_legacy_logdata() {
 
53
        $message = $this->get_record_snapshot('chat_messages', $this->objectid);
 
54
        return array($this->courseid, 'chat', 'talk', 'view.php?id=' . $this->context->instanceid,
 
55
            $message->chatid, $this->context->instanceid, $this->relateduserid);
 
56
    }
 
57
 
 
58
    /**
 
59
     * Return localised event name.
 
60
     *
 
61
     * @return string
 
62
     */
 
63
    public static function get_name() {
 
64
        return get_string('event_message_sent', 'mod_chat');
 
65
    }
 
66
 
 
67
    /**
 
68
     * Get URL related to the action
 
69
     *
 
70
     * @return \moodle_url
 
71
     */
 
72
    public function get_url() {
 
73
        return new \moodle_url('/mod/chat/view.php', array('id' => $this->context->instanceid));
 
74
    }
 
75
 
 
76
    /**
 
77
     * Init method.
 
78
     *
 
79
     * @return void
 
80
     */
 
81
    protected function init() {
 
82
        $this->data['crud'] = 'c';
 
83
        $this->data['level'] = self::LEVEL_PARTICIPATING;
 
84
        $this->data['objecttable'] = 'chat_messages';
 
85
    }
 
86
 
 
87
    /**
 
88
     * Custom validation.
 
89
     *
 
90
     * @return void
 
91
     */
 
92
    protected function validate_data() {
 
93
        if (!isset($this->relateduserid)) {
 
94
            throw new \coding_exception('The property relateduserid must be set.');
 
95
        }
 
96
    }
 
97
 
 
98
}