| 1 |
efrain |
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 |
* Abstract comment created event.
|
|
|
19 |
*
|
|
|
20 |
* @package core
|
|
|
21 |
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
namespace core\event;
|
|
|
26 |
|
|
|
27 |
defined('MOODLE_INTERNAL') || die();
|
|
|
28 |
|
|
|
29 |
/**
|
|
|
30 |
* Abstract comment created event class.
|
|
|
31 |
*
|
|
|
32 |
* This class has to be extended by any event which is triggred while creating new comment.
|
|
|
33 |
*
|
|
|
34 |
* @property-read array $other {
|
|
|
35 |
* Extra information about event.
|
|
|
36 |
*
|
|
|
37 |
* - int itemid: id of item for which comment is added.
|
|
|
38 |
* }
|
|
|
39 |
*
|
|
|
40 |
* @package core
|
|
|
41 |
* @since Moodle 2.7
|
|
|
42 |
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
|
|
|
43 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
44 |
*/
|
|
|
45 |
abstract class comment_created extends base {
|
|
|
46 |
|
|
|
47 |
/**
|
|
|
48 |
* Init method.
|
|
|
49 |
*
|
|
|
50 |
* @return void
|
|
|
51 |
*/
|
|
|
52 |
protected function init() {
|
|
|
53 |
$this->data['crud'] = 'c';
|
|
|
54 |
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
|
|
|
55 |
$this->data['objecttable'] = 'comments';
|
|
|
56 |
}
|
|
|
57 |
|
|
|
58 |
/**
|
|
|
59 |
* Return localised event name.
|
|
|
60 |
*
|
|
|
61 |
* @return string
|
|
|
62 |
*/
|
|
|
63 |
public static function get_name() {
|
|
|
64 |
return get_string('eventcommentcreated', 'moodle');
|
|
|
65 |
}
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* Returns description of what happened.
|
|
|
69 |
*
|
|
|
70 |
* @return string
|
|
|
71 |
*/
|
|
|
72 |
public function get_description() {
|
|
|
73 |
return "The user with id '$this->userid' added the comment with id '$this->objectid' to the '$this->component' " .
|
|
|
74 |
"with course module id '$this->contextinstanceid'.";
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
/**
|
|
|
78 |
* Get URL related to the action.
|
|
|
79 |
*
|
|
|
80 |
* @return \moodle_url
|
|
|
81 |
*/
|
|
|
82 |
public function get_url() {
|
|
|
83 |
$context = $this->get_context();
|
|
|
84 |
if ($context) {
|
|
|
85 |
return $context->get_url();
|
|
|
86 |
} else {
|
|
|
87 |
return null;
|
|
|
88 |
}
|
|
|
89 |
}
|
|
|
90 |
|
|
|
91 |
/**
|
|
|
92 |
* Custom validation.
|
|
|
93 |
*
|
|
|
94 |
* @throws \coding_exception
|
|
|
95 |
* @return void
|
|
|
96 |
*/
|
|
|
97 |
protected function validate_data() {
|
|
|
98 |
parent::validate_data();
|
|
|
99 |
if (!isset($this->other['itemid'])) {
|
|
|
100 |
throw new \coding_exception('The \'itemid\' value must be set in other.');
|
|
|
101 |
}
|
|
|
102 |
}
|
|
|
103 |
|
|
|
104 |
public static function get_objectid_mapping() {
|
|
|
105 |
return array('db' => 'comments', 'restore' => 'comment');
|
|
|
106 |
}
|
|
|
107 |
|
|
|
108 |
public static function get_other_mapping() {
|
|
|
109 |
// We cannot map fields that do not have a 1:1 mapping.
|
|
|
110 |
$othermapped = array();
|
|
|
111 |
$othermapped['itemid'] = base::NOT_MAPPED;
|
|
|
112 |
return $othermapped;
|
|
|
113 |
}
|
|
|
114 |
}
|