Класс BasePlugin
Базовый класс плагина
Каждый плагин должен наследоваться от этого класса или реализовывать интерфейсы и включать класс плагина в папку src своего корня.
- Cake\Core\BasePlugin реализует Cake\Core\PluginInterface
Унаследованные константы
Резюме свойств
-
$bootstrapEnabledprotectedПроизводить загрузку или нетboolean -
$classPathprotectedПуть к классу для этого плагина.string -
$configPathprotectedПуть к конфигурации для этого плагина.string -
$consoleEnabledprotectedСредства промежуточного слоя консолиboolean -
$middlewareEnabledprotectedВключить средства промежуточного слояboolean -
$nameprotectedИмя этого плагинаstring -
$pathprotectedПуть к этому плагину.string -
$routesEnabledprotectedЗагружать маршруты или нетboolean
Резюме методов
- __construct() publicКонструктор
- bootstrap() publicЗагрузка всей конфигурации приложения и логики загрузки.
- checkHook() protectedПроверить, является ли имя хука допустимым
- console() publicДобавление команд консоли для плагина.
- disable() publicОтключает указанный хук
- enable() publicВключает указанный хук
- getClassPath() publicПолучить файловый путь к конфигурации для этого плагина
- getConfigPath() publicПолучить файловый путь к конфигурации для этого плагина
- getName() publicПолучить имя этого плагина.
- getPath() publicПолучить файловый путь к этому плагину
- initialize() public
- isEnabled() publicПроверить, включён ли указанный хук
- middleware() publicДобавить средства промежуточного слоя для плагина.
- routes() publicДобавить маршруты для плагина.
Подробное описание методов
__construct()source public
__construct( array $options = [] )
Конструктор
Параметры
- массив
$optionsнеобязательно [] - Параметры
bootstrap()source public
bootstrap( Cake\Core\PluginApplicationInterface $app )
Загрузка всей конфигурации приложения и логики загрузки.
Параметры
-
Cake\Core\PluginApplicationInterface$app - Хост приложения
Реализация
Cake\Core\PluginInterface::bootstrap() checkHook()source protected
checkHook( string $hook )
Проверить, является ли имя хука допустимым
Параметры
- строка
$hook - Имя хука для проверки
Исключения
InvalidArgumentExceptionпри недопустимых хуках
console()source public
console( Cake\Console\CommandCollection $commands )
Добавление команд консоли для плагина.
Параметры
-
Cake\Console\CommandCollection$commands - Коллекция команд для обновления
Возвращает
Cake\Console\CommandCollectionРеализация
Cake\Core\PluginInterface::console() disable()source public
disable( string $hook )
Отключает указанный хук
Параметры
- строка
$hook - Хук для отключения
Возвращает
$this
Реализация
Cake\Core\PluginInterface::disable() enable()source public
enable( string $hook )
Включает указанный хук
Параметры
- строка
$hook - Хук для отключения
Возвращает
$this
Реализация
Cake\Core\PluginInterface::enable() getClassPath()source public
getClassPath( )
Получить файловый путь к конфигурации для этого плагина
Возвращает
строкаРеализация
Cake\Core\PluginInterface::getClassPath() getConfigPath()source public
getConfigPath( )
Получить файловый путь к конфигурации для этого плагина
Возвращает
строкаРеализация
Cake\Core\PluginInterface::getConfigPath() getName()source public
getName( )
Получить имя этого плагина.
Возвращает
строкаРеализация
Cake\Core\PluginInterface::getName() getPath()source public
getPath( )
Получить файловый путь к этому плагину
Возвращает
строкаРеализация
Cake\Core\PluginInterface::getPath() initialize()source public
initialize( )
isEnabled()source public
isEnabled( string $hook )
Проверить, включён ли указанный хук
Параметры
- строка
$hook - Хук для проверки
Возвращает
логическое значениеРеализация
Cake\Core\PluginInterface::isEnabled() middleware()source public
middleware( Cake\Http\MiddlewareQueue $middleware )
Добавить средства промежуточного слоя для плагина.
Параметры
-
Cake\Http\MiddlewareQueue$middleware - Очередь средств промежуточного слоя для обновления.
Возвращает
Cake\Http\MiddlewareQueueРеализация
Cake\Core\PluginInterface::middleware() routes()source public
routes( Cake\Routing\RouteBuilder $routes )
Добавить маршруты для плагина.
Параметры
-
Cake\Routing\RouteBuilder$routes - Строитель маршрутов для обновления.
Реализация
Cake\Core\PluginInterface::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.8/class-Cake.Core.BasePlugin.html
