Класс BasePlugin
Базовый класс плагина
Каждый плагин должен наследоваться от этого класса или реализовывать интерфейсы и включать класс плагина в папку src.
Константы
-
array<string>VALID_HOOKS['bootstrap', 'console', 'middleware', 'routes', 'services']
Список допустимых хуков.
Краткое описание свойств
- $bootstrapEnabled protected
boolПроизводить ли загрузку начальной настройки
- $classPath protected
stringПуть к классу плагина.
- $configPath protected
stringПуть к конфигурации плагина.
- $consoleEnabled protected
boolКонсольный посредник
- $middlewareEnabled protected
boolВключить посредник
- $name protected
stringНазвание плагина
- $path protected
stringПуть к плагину.
- $routesEnabled protected
boolЗагружать маршруты или нет
- $servicesEnabled protected
boolРегистрировать сервисы контейнера
- $templatePath protected
stringПуть к шаблонам плагина.
Краткое описание методов
-
__construct() public
Конструктор
-
bootstrap() public
Загрузка всех настроек приложения и логики загрузки.
-
checkHook() protected
Проверка, является ли имя хука допустимым
-
console() public
Добавление команд консоли для плагина.
-
disable() public
Отключает указанный хук
-
enable() public
Включает указанный хук
-
getClassPath() public
Получение пути в файловой системе к конфигурации этого плагина
-
getConfigPath() public
Получение пути в файловой системе к конфигурации этого плагина
-
getName() public
Получение имени этого плагина.
-
getPath() public
Получение пути в файловой системе к этому плагину
-
getTemplatePath() public
Получение пути в файловой системе к шаблонам для этого плагина
-
initialize() public
Хук инициализации, вызываемый из конструктора.
-
isEnabled() public
Проверка, включен ли указанный хук
-
middleware() public
Добавление промежуточного программного обеспечения для плагина.
-
routes() public
Добавление маршрутов для плагина.
-
services() public
Регистрация сервисов контейнера для этого плагина.
Подробное описание методов
__construct() public
__construct(array<string, mixed> $options = [])
Конструктор
Параметры
-
array<string, mixed>$options optional Параметры
bootstrap() public
bootstrap(Cake\Core\PluginApplicationInterface $app): void
Загрузка всех настроек приложения и логики загрузки.
Реализация этого метода по умолчанию будет включать config/bootstrap.php в плагине, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.
Хост-приложение предоставляется в качестве аргумента. Это позволяет загружать дополнительные зависимости плагинов или подключать события.
Параметры
-
Cake\Core\PluginApplicationInterface$app
Возвращает
voidcheckHook() protected
checkHook(string $hook): void
Проверка, является ли имя хука допустимым
Параметры
-
string$hook Имя хука для проверки
Возвращает
voidИсключения
InvalidArgumentExceptionдля недопустимых хуков
console() public
console(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollection
Добавление команд консоли для плагина.
Параметры
-
Cake\Console\CommandCollection$commands
Возвращает
Cake\Console\CommandCollectiondisable() public
disable(string $hook): $this
Отключает указанный хук
Параметры
-
string$hook
Возвращает
$thisenable() public
enable(string $hook): $this
Включает указанный хук
Параметры
-
string$hook
Возвращает
$thisgetClassPath() public
getClassPath(): string
Получение пути в файловой системе к конфигурации этого плагина
Возвращает
stringgetConfigPath() public
getConfigPath(): string
Получение пути в файловой системе к конфигурации этого плагина
Возвращает
stringgetName() public
getName(): string
Получение имени этого плагина.
Возвращает
stringgetPath() public
getPath(): string
Получение пути в файловой системе к этому плагину
Возвращает
stringgetTemplatePath() public
getTemplatePath(): string
Получение пути в файловой системе к шаблонам для этого плагина
Возвращает
stringinitialize() public
initialize(): void
Хук инициализации, вызываемый из конструктора.
Возвращает
voidisEnabled() public
isEnabled(string $hook): bool
Проверка, включен ли указанный хук
Параметры
-
string$hook
Возвращает
boolmiddleware() public
middleware(Cake\Http\MiddlewareQueue $middlewareQueue): Cake\Http\MiddlewareQueue
Добавление промежуточного программного обеспечения для плагина.
Параметры
-
Cake\Http\MiddlewareQueue$middlewareQueue
Возвращает
Cake\Http\MiddlewareQueueroutes() public
routes(Cake\Routing\RouteBuilder $routes): void
Добавление маршрутов для плагина.
Реализация этого метода по умолчанию будет включать config/routes.php в плагине, если он существует. Вы можете переопределить этот метод, чтобы заменить это поведение.
Параметры
-
Cake\Routing\RouteBuilder$routes
Возвращает
voidservices() public
services(Cake\Core\ContainerInterface $container): void
Регистрация сервисов контейнера для этого плагина.
Параметры
-
Cake\Core\ContainerInterface$container Контейнер, в который нужно добавить сервисы.
Возвращает
voidПодробное описание свойства
$bootstrapEnabled protected
Выполнять загрузку или нет
Тип
bool$classPath protected
Путь к классу для этого плагина.
Тип
string$configPath protected
Путь к конфигурации для этого плагина.
Тип
string$consoleEnabled protected
Консольный посредник
Тип
bool$middlewareEnabled protected
Включить посредника
Тип
bool$name protected
Название этого плагина
Тип
string$path protected
Путь к этому плагину.
Тип
string$routesEnabled protected
Загрузить маршруты или нет
Тип
bool$servicesEnabled protected
Регистрация сервисов контейнера
Тип
bool$templatePath protected
Путь к шаблонам для этого плагина.
Тип
string
© 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.3/class-Cake.Core.BasePlugin.html
