Интерфейс PluginInterface

Интерфейс плагина

Пространство имён: Cake\Core

Константы

array<string>

VALID_HOOKS
```
['bootstrap', 'console', 'middleware', 'routes', 'services']
```
Список допустимых хуков.

Краткое описание методов

bootstrap() public

Загрузка всей конфигурации приложения и логики загрузки.
console() public

Добавление команд консоли для плагина.
disable() public

Отключает указанный хук
enable() public

Включает указанный хук
getClassPath() public

Получение пути к файловой системе для конфигурации этого плагина
getConfigPath() public

Получение пути к файловой системе для конфигурации этого плагина
getName() public

Получение имени этого плагина.
getPath() public

Получение пути к файловой системе для этого плагина
getTemplatePath() public

Получение пути к файловой системе для шаблонов этого плагина
isEnabled() public

Проверка, включён ли указанный хук
middleware() public

Добавление middleware для плагина.
routes() public

Добавление маршрутов для плагина.
services() public @method

Регистрация сервисов плагина в контейнере приложения

Подробное описание методов

bootstrap() public

bootstrap(Cake\Core\PluginApplicationInterface $app): void

Загрузка всей конфигурации приложения и логики загрузки.

Реализация по умолчанию этого метода будет включать config/bootstrap.php в плагин, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.

Приложение-хост предоставляется в качестве аргумента. Это позволяет загружать дополнительные зависимости плагина или присоединять события.

Параметры

Cake\Core\PluginApplicationInterface $app: Приложение-хост

Возвращаемое значение

void

console() public

console(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollection

Добавление команд консоли для плагина.

Параметры

Cake\Console\CommandCollection $commands: Коллекция команд для обновления

Возвращаемое значение

Cake\Console\CommandCollection

disable() public

disable(string $hook): $this

Отключает указанный хук

Параметры

string $hook: Хук для отключения

Возвращаемое значение

$this

enable() public

enable(string $hook): $this

Включает указанный хук

Параметры

string $hook: Хук для отключения

Возвращаемое значение

$this

getClassPath() public

getClassPath(): string

Получение пути к файловой системе для конфигурации этого плагина

Возвращаемое значение

string

getConfigPath() public

getConfigPath(): string

Получение пути к файловой системе для конфигурации этого плагина

Возвращаемое значение

string

getName() public

getName(): string

Получение имени этого плагина.

Возвращаемое значение

string

getPath() public

getPath(): string

Получение пути к файловой системе для этого плагина

Возвращаемое значение

string

getTemplatePath() public

getTemplatePath(): string

Получение пути к файловой системе для шаблонов этого плагина

Возвращаемое значение

string

isEnabled() public

isEnabled(string $hook): bool

Проверка, включён ли указанный хук

Параметры

string $hook: Хук для проверки

Возвращаемое значение

bool

middleware() public

middleware(Cake\Http\MiddlewareQueue $middlewareQueue): Cake\Http\MiddlewareQueue

Добавление middleware для плагина.

Параметры

Cake\Http\MiddlewareQueue $middlewareQueue: Очередь middleware для обновления.

Возвращаемое значение

Cake\Http\MiddlewareQueue

routes() public

routes(Cake\Routing\RouteBuilder $routes): void

Добавление маршрутов для плагина.

Реализация по умолчанию этого метода включит config/routes.php в плагин, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.

Параметры

Cake\Routing\RouteBuilder $routes: Строитель маршрутов для обновления.

Возвращаемое значение

void

services() public @method

services(Cake\Core\ContainerInterface $container): void

Регистрация сервисов плагина в контейнере приложения

Параметры

Cake\Core\ContainerInterface $container

Возвращаемое значение

void

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/interface-Cake.Core.PluginInterface.html