MDL-40053 events: write events for core_notes
[moodle.git] / lib / classes / event / note_created.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/>.
17 namespace core\event;
19 defined('MOODLE_INTERNAL') || die();
21 /**
22  * Event for when a new note entry is added.
23  *
24  * @package    core
25  * @copyright  2013 Ankit Agarwal
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 /**
30  * Class note_created
31  *
32  * Class for event to be triggered when a note is created.
33  *
34  * @package    core
35  * @copyright  2013 Ankit Agarwal
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class note_created extends \core\event\base {
40     /**
41      * Set basic properties for the event.
42      */
43     protected function init() {
44         $this->data['objecttable'] = 'post';
45         $this->data['crud'] = 'c';
46         $this->data['level'] = self::LEVEL_OTHER;
47     }
49     /**
50      * Returns localised general event name.
51      *
52      * @return string
53      */
54     public static function get_name() {
55         return get_string("eventnotecreated", "core_notes");
56     }
58     /**
59      * Returns non-localised event description with id's for admin use only.
60      *
61      * @return string
62      */
63     public function get_description() {
64         return 'Note for user with id "'. $this->relateduserid . '" was created by user with id "' . $this->userid . '"';
65     }
67     /**
68      * Returns relevant URL.
69      * @return \moodle_url
70      */
71     public function get_url() {
72         $logurl = new \moodle_url('/note/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
73         $logurl->set_anchor('note-' . $this->objectid);
74         return $logurl;
75     }
77     /**
78      * replace add_to_log() statement.
79      *
80      * @return array of parameters to be passed to legacy add_to_log() function.
81      */
82     protected function get_legacy_logdata() {
83         $logurl = new \moodle_url('index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
84         $logurl->set_anchor('note-' . $this->objectid);
85         return array($this->courseid, 'notes', 'add', $logurl, 'add note');
86     }
87 }