mirror of
https://github.com/moodle/moodle.git
synced 2025-08-04 16:36:37 +02:00
59 lines
2.1 KiB
PHP
59 lines
2.1 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_enrol\hook;
|
|
|
|
use stdClass;
|
|
|
|
/**
|
|
* Hook before a user enrolment is updated.
|
|
*
|
|
* @package core_enrol
|
|
* @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 user enrolment is updated.')]
|
|
#[\core\attribute\tags('enrol', 'user')]
|
|
class before_user_enrolment_updated {
|
|
/**
|
|
* Constructor for the hook.
|
|
*
|
|
* @param stdClass $enrolinstance The enrol instance.
|
|
* @param stdClass $userenrolmentinstance The user enrolment instance.
|
|
* @param bool $statusmodified Whether the status of the enrolment has been modified.
|
|
* @param bool $timeendmodified Whether the time end of the enrolment has been modified.
|
|
*/
|
|
public function __construct(
|
|
/** @var stdClass The enrol instance */
|
|
public readonly stdClass $enrolinstance,
|
|
/** @var stdClass The user enrolment instance */
|
|
public readonly stdClass $userenrolmentinstance,
|
|
/** @var bool Whether the status of the enrolment has been modified */
|
|
public readonly bool $statusmodified,
|
|
/** @var bool Whether the time end of the enrolment has been modified */
|
|
public readonly bool $timeendmodified,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* Get the user id.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_userid(): int {
|
|
return $this->userenrolmentinstance->userid;
|
|
}
|
|
}
|