mirror of
https://github.com/moodle/moodle.git
synced 2025-08-04 16:36:37 +02:00
58 lines
1.7 KiB
PHP
58 lines
1.7 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/>.
|
|
|
|
namespace core_course\hook;
|
|
|
|
use stdClass;
|
|
use Psr\EventDispatcher\StoppableEventInterface;
|
|
|
|
/**
|
|
* Hook before course deletion.
|
|
*
|
|
* @package core_course
|
|
* @copyright 2024 Safat Shahin <safat.shahin@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
#[\core\attribute\label('Allows plugins or features to perform actions before a course is deleted.')]
|
|
#[\core\attribute\tags('course')]
|
|
class before_course_deleted implements
|
|
StoppableEventInterface {
|
|
/**
|
|
* @var bool Whether the propagation of this event has been stopped.
|
|
*/
|
|
protected bool $stopped = false;
|
|
|
|
/**
|
|
* Constructor for the hook.
|
|
*
|
|
* @param stdClass $course The course instance.
|
|
*/
|
|
public function __construct(
|
|
public readonly stdClass $course,
|
|
) {
|
|
}
|
|
|
|
public function isPropagationStopped(): bool {
|
|
return $this->stopped;
|
|
}
|
|
|
|
/**
|
|
* Stop the propagation of this event.
|
|
*/
|
|
public function stop(): void {
|
|
$this->stopped = true;
|
|
}
|
|
}
|