| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace core\hook;
|
|
|
18 |
|
|
|
19 |
/**
|
|
|
20 |
* Interface for a hook to provide a description of itself for administrator information.
|
|
|
21 |
*
|
|
|
22 |
* @package core
|
|
|
23 |
* @author Petr Skoda
|
|
|
24 |
* @copyright 2022 Open LMS
|
|
|
25 |
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
26 |
*/
|
|
|
27 |
interface described_hook {
|
|
|
28 |
/**
|
|
|
29 |
* Hook purpose description in Markdown format
|
|
|
30 |
* used on Hooks overview page.
|
|
|
31 |
*
|
|
|
32 |
* It should include description of callback priority setting
|
|
|
33 |
* rules if applicable.
|
|
|
34 |
*
|
|
|
35 |
* @return string
|
|
|
36 |
*/
|
|
|
37 |
public static function get_hook_description(): string;
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* List of tags that describe this hook.
|
|
|
41 |
*
|
|
|
42 |
* @return string[]
|
|
|
43 |
*/
|
|
|
44 |
public static function get_hook_tags(): array;
|
|
|
45 |
}
|