user/classes/hook/before_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 namespace core_user\hook;
  18
  19 use stdClass;
  20 use Psr\EventDispatcher\StoppableEventInterface;
  21
  22 /**
  23  * Hook before user deletion.
  24  *
  25  * @package    core_user
  26  * @copyright  2024 Safat Shahin <safat.shahin@moodle.com>
  27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29 #[\core\attribute\label('Allows plugins or features to perform actions before a user is deleted.')]
  30 #[\core\attribute\tags('user')]
  31 class before_user_deleted implements
  32     StoppableEventInterface {
  33
  34     /**
  35      * @var bool Whether the propagation of this event has been stopped.
  36      */
  37     protected bool $stopped = false;
  38
  39     /**
  40      * Constructor for the hook.
  41      *
  42      * @param stdClass $user The user instance
  43      */
  44     public function __construct(
  45         public readonly stdClass $user,
  46     ) {
  47     }
  48
  49     public function isPropagationStopped(): bool {
  50         return $this->stopped;
  51     }
  52
  53     /**
  54      * Stop the propagation of this event.
  55      */
  56     public function stop(): void {
  57         $this->stopped = true;
  58     }
  59 }