Интерфейс PluginApplicationInterface

Интерфейс для приложений, использующих плагины и события.

События могут быть привязаны к менеджеру событий приложения во время загрузки приложения и загрузки плагинов.

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

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

addPlugin() public

Добавить плагин в набор загруженных плагинов.
dispatchEvent() public

Обёртка для создания и отправки событий.
getEventManager() public

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.
pluginBootstrap() public

Выполнить логику загрузки для загруженных плагинов.
pluginConsole() public

Выполнить консольные хуки для плагинов
pluginMiddleware() public

Выполнить хуки для промежуточного ПО плагинов
pluginRoutes() public

Выполнить хуки маршрутизации для загруженных плагинов
setEventManager() public

Устанавливает экземпляр менеджера Cake\Event\EventManager для данного объекта.

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

addPlugin() public

addPlugin(Cake\Core\PluginInterface|string $name, array<string, mixed> $config = []): $this

Добавить плагин в набор загруженных плагинов.

Если плагин с указанным именем не существует или не определяет класс Plugin, будет использован экземпляр Cake\Core\BasePlugin. Этот сгенерированный класс будет иметь все плагины включенными.

Параметры

Cake\Core\PluginInterface|string $name: Имя плагина или объект плагина.
array<string, mixed> $config необязательно: Данные конфигурации плагина, если для $name используется строка.

Возвращает

$this

dispatchEvent() public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

Обёртка для создания и отправки событий.

Возвращает обработанное событие.

Параметры

string $name: Имя события.
array|null $data необязательно: Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.
object|null $subject необязательно: Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\EventInterface

getEventManager() public

getEventManager(): Cake\Event\EventManagerInterface

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.

Возвращает

Cake\Event\EventManagerInterface

pluginBootstrap() public

pluginBootstrap(): void

Выполнить логику загрузки для загруженных плагинов.

Возвращает

void

pluginConsole() public

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

Выполнить консольные хуки для плагинов

Параметры

Cake\Console\CommandCollection $commands: Коллекция команд, которую нужно использовать.

Возвращает

Cake\Console\CommandCollection

pluginMiddleware() public

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

Выполнить хуки для промежуточного ПО плагинов

Параметры

Cake\Http\MiddlewareQueue $middleware: Очередь промежуточного ПО, которую нужно использовать.

Возвращает

Cake\Http\MiddlewareQueue

pluginRoutes() public

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

Выполнить хуки маршрутизации для загруженных плагинов

Параметры

Cake\Routing\RouteBuilder $routes: Строитель маршрутов, который нужно использовать.

Возвращает

Cake\Routing\RouteBuilder

setEventManager() public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Устанавливает экземпляр менеджера Cake\Event\EventManager для данного объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов на события объекта, или создать свои собственные события и вызывать их по своему желанию.

Параметры

Cake\Event\EventManagerInterface $eventManager: Устанавливаемый менеджер событий

Возвращает

$this

© 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/interface-Cake.Core.PluginApplicationInterface.html