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/>.
  16
  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;
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  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 {
  46
  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     }
  55
  56     /**
  57      * Returns localised event name.
  58      *
  59      * @return string
  60      */
  61     public static function get_name() {
  62         return get_string('eventuserdeleted');
  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 'User profile deleted for userid ' . $this->objectid;
  72     }
  73
  74     /**
  75      * Return name of the legacy event, which is replaced by this event.
  76      *
  77      * @return string legacy event name
  78      */
  79     public static function get_legacy_eventname() {
  80         return 'user_deleted';
  81     }
  82
  83     /**
  84      * Return user_deleted legacy event data.
  85      *
  86      * @return \stdClass user data.
  87      */
  88     protected function get_legacy_eventdata() {
  89         $user = $this->get_record_snapshot('user', $this->data['objectid']);
  90         $user->deleted = 0;
  91         $user->username = $this->data['other']['username'];
  92         $user->email = $this->data['other']['email'];
  93         $user->idnumber = $this->data['other']['idnumber'];
  94         $user->picture = $this->data['other']['picture'];
  95         return $user;
  96     }
  97
  98     /**
  99      * Returns array of parameters to be passed to legacy add_to_log() function.
 100      *
 101      * @return array
 102      */
 103     protected function get_legacy_logdata() {
 104         $user = $this->get_record_snapshot('user', $this->data['objectid']);
 105         return array(SITEID, 'user', 'delete', "view.php?id=".$user->id, $user->firstname.' '.$user->lastname);
 106     }
 107
 108     /**
 109      * Custom validation.
 110      *
 111      * @throws \coding_exception
 112      * @return void
 113      */
 114     protected function validate_data() {
 115         parent::validate_data();
 116
 117         if (!isset($this->other['username'])) {
 118             throw new \coding_exception('username must be set in $other.');
 119         }
 120
 121         if (!isset($this->other['email'])) {
 122             throw new \coding_exception('email must be set in $other.');
 123         }
 124
 125         if (!isset($this->other['idnumber'])) {
 126             throw new \coding_exception('idnumber must be set in $other.');
 127         }
 128
 129         if (!isset($this->other['picture'])) {
 130             throw new \coding_exception('picture must be set in $other.');
 131         }
 132
 133         if (!isset($this->other['mnethostid'])) {
 134             throw new \coding_exception('mnethostid must be set in $other.');
 135         }
 136     }
 137 }