source: moodle/trunk/fuentes/lib/classes/event/note_deleted.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 3.1 KB
Line 
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 * Event for when a new note entry deleted.
19 *
20 * @package    core
21 * @copyright  2013 Ankit Agarwal
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Class note_deleted
31 *
32 * Class for event to be triggered when a note is deleted.
33 *
34 * @property-read array $other {
35 *      Extra information about event.
36 *
37 *      - string publishstate: (optional) the publish state.
38 * }
39 *
40 * @package    core
41 * @since      Moodle 2.6
42 * @copyright  2013 Ankit Agarwal
43 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44 */
45class note_deleted extends base {
46
47    /**
48     * Set basic properties for the event.
49     */
50    protected function init() {
51        $this->data['objecttable'] = 'post';
52        $this->data['crud'] = 'd';
53        $this->data['edulevel'] = self::LEVEL_OTHER;
54    }
55
56    /**
57     * Returns localised general event name.
58     *
59     * @return string
60     */
61    public static function get_name() {
62        return get_string("eventnotedeleted", "core_notes");
63    }
64
65    /**
66     * Returns non-localised event description with id's for admin use only.
67     *
68     * @return string
69     */
70    public function get_description() {
71        return "The user with id '$this->userid' deleted the note with id '$this->objectid' for the user with id " .
72            "'$this->relateduserid'";
73    }
74
75    /**
76     * replace add_to_log() statement.
77     *
78     * @return array of parameters to be passed to legacy add_to_log() function.
79     */
80    protected function get_legacy_logdata() {
81        $logurl = new \moodle_url('index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
82        $logurl->set_anchor('note-' . $this->objectid);
83        return array($this->courseid, 'notes', 'delete', $logurl, 'delete note');
84    }
85
86    /**
87     * Custom validation.
88     *
89     * @throws \coding_exception
90     * @return void
91     */
92    protected function validate_data() {
93        parent::validate_data();
94
95        if (!isset($this->relateduserid)) {
96            throw new \coding_exception('The \'relateduserid\' must be set.');
97        }
98    }
99
100    public static function get_objectid_mapping() {
101        // Notes are not backed up, so no need to map on restore.
102        return array('db' => 'post', 'restore' => base::NOT_MAPPED);
103    }
104
105    public static function get_other_mapping() {
106        // Nothing to map.
107        return false;
108    }
109}
Note: See TracBrowser for help on using the repository browser.