moodle/lib/classes/event/user_deleted.php
2023-03-07 13:08:46 +08:00

121 lines
3.5 KiB
PHP

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* User deleted event.
*
* @package core
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\event;
defined('MOODLE_INTERNAL') || die();
/**
* User deleted event class.
*
* @property-read array $other {
* Extra information about event.
*
* - string username: name of user.
* - string email: user email.
* - string idnumber: user idnumber.
* - string picture: user picture.
* - int mnethostid: mnet host id.
* }
*
* @package core
* @since Moodle 2.6
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class user_deleted extends base {
/**
* Initialise required event data properties.
*/
protected function init() {
$this->data['objecttable'] = 'user';
$this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_OTHER;
}
/**
* Returns localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventuserdeleted');
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' deleted the user with id '$this->objectid'.";
}
/**
* Custom validation.
*
* @throws \coding_exception
* @return void
*/
protected function validate_data() {
parent::validate_data();
if (!isset($this->relateduserid)) {
debugging('The \'relateduserid\' value must be specified in the event.', DEBUG_DEVELOPER);
$this->relateduserid = $this->objectid;
}
if (!isset($this->other['username'])) {
throw new \coding_exception('The \'username\' value must be set in other.');
}
if (!isset($this->other['email'])) {
throw new \coding_exception('The \'email\' value must be set in other.');
}
if (!isset($this->other['idnumber'])) {
throw new \coding_exception('The \'idnumber\' value must be set in other.');
}
if (!isset($this->other['picture'])) {
throw new \coding_exception('The \'picture\' value must be set in other.');
}
if (!isset($this->other['mnethostid'])) {
throw new \coding_exception('The \'mnethostid\' value must be set in other.');
}
}
public static function get_objectid_mapping() {
return array('db' => 'user', 'restore' => 'user');
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['mnethostid'] = array('db' => 'mnet_host', 'restore' => base::NOT_MAPPED);
return $othermapped;
}
}