MDL-42584 Events: modified get_description in events
[moodle.git] / lib / classes / event / user_deleted.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 /**
18  * User deleted 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 namespace core\event;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Event when user profile is deleted.
30  *
31  * @package    core
32  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class user_deleted extends base {
37     /**
38      * Initialise required event data properties.
39      */
40     protected function init() {
41         $this->data['objecttable'] = 'user';
42         $this->data['crud'] = 'd';
43         $this->data['level'] = self::LEVEL_OTHER;
44     }
46     /**
47      * Returns localised event name.
48      *
49      * @return string
50      */
51     public static function get_name() {
52         return get_string('eventuserdeleted');
53     }
55     /**
56      * Returns non-localised event description with id's for admin use only.
57      *
58      * @return string
59      */
60     public function get_description() {
61         $user = (object)$this->other['user'];
62         return 'User profile deleted for userid ' . $user->id;
63     }
65     /**
66      * Return name of the legacy event, which is replaced by this event.
67      *
68      * @return string legacy event name
69      */
70     public static function get_legacy_eventname() {
71         return 'user_deleted';
72     }
74     /**
75      * Return user_deleted legacy event data.
76      *
77      * @return \stdClass user data.
78      */
79     protected function get_legacy_eventdata() {
80         return (object)$this->other['user'];
81     }
83     /**
84      * Returns array of parameters to be passed to legacy add_to_log() function.
85      *
86      * @return array
87      */
88     protected function get_legacy_logdata() {
89         $user = (object)$this->other['user'];
90         return array(SITEID, 'user', 'delete', "view.php?id=$user->id", $user->firstname.' '.$user->lastname);
91     }
93     /**
94      * Custom validation.
95      *
96      * @throws \coding_exception
97      * @return void
98      */
99     protected function validate_data() {
100         parent::validate_data();
101         if (!isset($this->other['user'])) {
102             throw new \coding_exception('user must be set in $other.');
103         }
104     }