| 1 |
efrain |
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 |
|
|
|
21 |
/**
|
|
|
22 |
* Hook before a user enrolment is updated.
|
|
|
23 |
*
|
|
|
24 |
* @package core_enrol
|
|
|
25 |
* @copyright 2024 Safat Shahin <safat.shahin@moodle.com>
|
|
|
26 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
27 |
*/
|
|
|
28 |
#[\core\attribute\label('Allows plugins or features to perform actions before a user enrolment is updated.')]
|
|
|
29 |
#[\core\attribute\tags('enrol', 'user')]
|
|
|
30 |
class before_user_enrolment_updated {
|
|
|
31 |
/**
|
|
|
32 |
* Constructor for the hook.
|
|
|
33 |
*
|
|
|
34 |
* @param stdClass $enrolinstance The enrol instance.
|
|
|
35 |
* @param stdClass $userenrolmentinstance The user enrolment instance.
|
|
|
36 |
* @param bool $statusmodified Whether the status of the enrolment has been modified.
|
|
|
37 |
* @param bool $timeendmodified Whether the time end of the enrolment has been modified.
|
|
|
38 |
*/
|
|
|
39 |
public function __construct(
|
|
|
40 |
/** @var stdClass The enrol instance */
|
|
|
41 |
public readonly stdClass $enrolinstance,
|
|
|
42 |
/** @var stdClass The user enrolment instance */
|
|
|
43 |
public readonly stdClass $userenrolmentinstance,
|
|
|
44 |
/** @var bool Whether the status of the enrolment has been modified */
|
|
|
45 |
public readonly bool $statusmodified,
|
|
|
46 |
/** @var bool Whether the time end of the enrolment has been modified */
|
|
|
47 |
public readonly bool $timeendmodified,
|
|
|
48 |
) {
|
|
|
49 |
}
|
|
|
50 |
|
|
|
51 |
/**
|
|
|
52 |
* Get the user id.
|
|
|
53 |
*
|
|
|
54 |
* @return int
|
|
|
55 |
*/
|
|
|
56 |
public function get_userid(): int {
|
|
|
57 |
return $this->userenrolmentinstance->userid;
|
|
|
58 |
}
|
|
|
59 |
}
|