MDL-40053 events: write events for core_notes
[moodle.git] / lib / classes / event / notes_viewed.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 viewed.
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_viewed
31  *
32  * Class for event to be triggered when a note is viewed.
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 notes_viewed extends \core\event\content_viewed {
40     /**
41      * Set basic properties for the event.
42      */
43     protected function init() {
44         $this->data['crud'] = 'r';
45         $this->data['level'] = self::LEVEL_OTHER;
46     }
48     /**
49      * Returns localised general event name.
50      *
51      * @return string
52      */
53     public static function get_name() {
54         return get_string("eventnotesviewed", "core_notes");
55     }
57     /**
58      * Returns non-localised event description with id's for admin use only.
59      *
60      * @return string
61      */
62     public function get_description() {
63         return 'Note for user with id "'. $this->relateduserid . '" was viewed by user with id "'. $this->userid . '"';
64     }
66     /**
67      * Returns relevant URL.
68      * @return \moodle_url
69      */
70     public function get_url() {
71         return new \moodle_url('/note/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
72     }
74     /**
75      * replace add_to_log() statement.
76      *
77      * @return array of parameters to be passed to legacy add_to_log() function.
78      */
79     protected function get_legacy_logdata() {
80         return array($this->courseid, 'notes', 'view', 'index.php?course=' . $this->courseid.'&amp;user=' . $this->relateduserid,
81             'view notes');
82     }
83 }