Интерфейс PluginInterface
Интерфейс плагина
Прямые реализаторы
Краткое описание констант
-
arrayVALID_HOOKS['routes','bootstrap','console','middleware']
Краткое описание методов
- bootstrap() publicЗагрузить всю конфигурацию приложения и логику загрузки.
- console() publicДобавить консольные команды для плагина.
- disable() publicОтключает указанный хук
- enable() publicВключает указанный хук
- getClassPath() publicПолучить путь к файловой системе для конфигурации этого плагина
- getConfigPath() publicПолучить путь к файловой системе для конфигурации этого плагина
- getName() publicПолучить имя этого плагина.
- getPath() publicПолучить путь к файловой системе для этого плагина
- isEnabled() publicПроверить, включен ли указанный хук
- middleware() publicДобавить мидлвейр для плагина.
- routes() publicДобавить маршруты для плагина.
Подробное описание методов
bootstrap()source public
bootstrap( Cake\Core\PluginApplicationInterface $app )
Загрузить всю конфигурацию приложения и логику загрузки.
Реализация по умолчанию этого метода будет включать config/bootstrap.php в плагин, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.
Прикладное приложение предоставляется в качестве аргумента. Это позволяет загрузить дополнительные зависимости плагина или привязать события.
Параметры
-
Cake\Core\PluginApplicationInterface$app - Приложение-хост
console()source public
console( Cake\Console\CommandCollection $commands )
Добавить консольные команды для плагина.
Параметры
-
Cake\Console\CommandCollection$commands - Коллекция команд для обновления
Возвращает
Cake\Console\CommandCollectiondisable()source public
disable( string $hook )
Отключает указанный хук
Параметры
- строка
$hook - Хук для отключения
Возвращает
$this
enable()source public
enable( string $hook )
Включает указанный хук
Параметры
- строка
$hook - Хук для отключения
Возвращает
$this
getClassPath()source public
getClassPath( )
Получить путь к файловой системе для конфигурации этого плагина
Возвращает
строкаgetConfigPath()source public
getConfigPath( )
Получить путь к файловой системе для конфигурации этого плагина
Возвращает
строкаgetPath()source public
getPath( )
Получить путь к файловой системе для этого плагина
Возвращает
строкаisEnabled()source public
isEnabled( string $hook )
Проверить, включен ли указанный хук
Параметры
- строка
$hook - Хук для проверки
Возвращает
булевоmiddleware()source public
middleware( Cake\Http\MiddlewareQueue $middleware )
Добавить мидлвейр для плагина.
Параметры
-
Cake\Http\MiddlewareQueue$middleware - Очередь мидлвейра для обновления.
Возвращает
Cake\Http\MiddlewareQueueroutes()source public
routes( Cake\Routing\RouteBuilder $routes )
Добавить маршруты для плагина.
Реализация по умолчанию этого метода будет включать config/routes.php в плагин, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.
Параметры
-
Cake\Routing\RouteBuilder$routes - Строитель маршрутов для обновления.
© 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/3.6/class-Cake.Core.PluginInterface.html