mirror of
https://github.com/moodle/moodle.git
synced 2025-02-21 01:48:45 +01:00
46 lines
1.4 KiB
PHP
46 lines
1.4 KiB
PHP
<?php
|
|
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
|
|
|
|
namespace core\hook;
|
|
|
|
/**
|
|
* Interface for a hook to provide a description of itself for administrator information.
|
|
*
|
|
* @package core
|
|
* @author Petr Skoda
|
|
* @copyright 2022 Open LMS
|
|
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface described_hook {
|
|
/**
|
|
* Hook purpose description in Markdown format
|
|
* used on Hooks overview page.
|
|
*
|
|
* It should include description of callback priority setting
|
|
* rules if applicable.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_hook_description(): string;
|
|
|
|
/**
|
|
* List of tags that describe this hook.
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public static function get_hook_tags(): array;
|
|
}
|