enrol/classes/hook/before_enrol_instance_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_enrol\hook;
  18
  19 use stdClass;
  20 use Psr\EventDispatcher\StoppableEventInterface;
  21
  22 /**
  23  * Hook before enrolment instance is deleted.
  24  *
  25  * @package    core_enrol
  26  * @copyright  20234 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 the enrolment instance is deleted.')]
  30 #[\core\attribute\tags('enrol', 'user')]
  31 class before_enrol_instance_deleted implements
  32     StoppableEventInterface
  33 {
  34     use \core\hook\stoppable_trait;
  35
  36     /**
  37      * Constructor for the hook.
  38      *
  39      * @param stdClass $enrolinstance The enrol instance.
  40      */
  41     public function __construct(
  42         /** @var stdClass The enrol instance */
  43         public readonly stdClass $enrolinstance,
  44     ) {
  45     }
  46 }