719c105634877ece61651c36219a7be0fefa979f
[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  * @property-read array $other {
32  *      Extra information about event.
33  *
34  *      @type string username name of user.
35  *      @type string email user email.
36  *      @type string idnumber user idnumber.
37  *      @type string picture user picture.
38  *      @type int mnethostid mnet host id.
39  * }
40  *
41  * @package    core
42  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class user_deleted extends base {
47     /**
48      * Initialise required event data properties.
49      */
50     protected function init() {
51         $this->data['objecttable'] = 'user';
52         $this->data['crud'] = 'd';
53         $this->data['edulevel'] = self::LEVEL_OTHER;
54     }
56     /**
57      * Returns localised event name.
58      *
59      * @return string
60      */
61     public static function get_name() {
62         return get_string('eventuserdeleted');
63     }
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         $user = $this->get_record_snapshot('user', $this->data['objectid']);
72         return 'User profile deleted for userid ' . $user->id;
73     }
75     /**
76      * Return name of the legacy event, which is replaced by this event.
77      *
78      * @return string legacy event name
79      */
80     public static function get_legacy_eventname() {
81         return 'user_deleted';
82     }
84     /**
85      * Return user_deleted legacy event data.
86      *
87      * @return \stdClass user data.
88      */
89     protected function get_legacy_eventdata() {
90         $user = $this->get_record_snapshot('user', $this->data['objectid']);
91         $user->deleted = 0;
92         $user->username = $this->data['other']['username'];
93         $user->email = $this->data['other']['email'];
94         $user->idnumber = $this->data['other']['idnumber'];
95         $user->picture = $this->data['other']['picture'];
96         return $user;
97     }
99     /**
100      * Returns array of parameters to be passed to legacy add_to_log() function.
101      *
102      * @return array
103      */
104     protected function get_legacy_logdata() {
105         $user = $this->get_record_snapshot('user', $this->data['objectid']);
106         return array(SITEID, 'user', 'delete', "view.php?id=".$user->id, $user->firstname.' '.$user->lastname);
107     }
109     /**
110      * Custom validation.
111      *
112      * @throws \coding_exception
113      * @return void
114      */
115     protected function validate_data() {
116         parent::validate_data();
118         if (!isset($this->other['username'])) {
119             throw new \coding_exception('username must be set in $other.');
120         }
122         if (!isset($this->other['email'])) {
123             throw new \coding_exception('email must be set in $other.');
124         }
126         if (!isset($this->other['idnumber'])) {
127             throw new \coding_exception('idnumber must be set in $other.');
128         }
130         if (!isset($this->other['picture'])) {
131             throw new \coding_exception('picture must be set in $other.');
132         }
134         if (!isset($this->other['mnethostid'])) {
135             throw new \coding_exception('mnethostid must be set in $other.');
136         }
137     }