Spec-Zone.ru › CakePHP 3.6

Интерфейс PluginInterface

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

Прямые реализаторы

  • Cake\Core\BasePlugin
Пространство имён: Cake\Core
Расположение: Core/PluginInterface.php

Краткое описание констант

  • array

    VALID_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\CommandCollection

disable()source public

disable( string $hook )

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

Параметры

строка $hook
Хук для отключения

Возвращает


$this

enable()source public

enable( string $hook )

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

Параметры

строка $hook
Хук для отключения

Возвращает


$this

getClassPath()source public

getClassPath( )

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

Возвращает

строка

getConfigPath()source public

getConfigPath( )

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

Возвращает

строка

getName()source public

getName( )

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

Возвращает

строка

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\MiddlewareQueue

routes()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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API