Интерфейс EventManagerInterface
Интерфейс EventManagerInterface
Краткое описание методов
-
dispatch() public
Отправляет новое событие всем настроенным слушателям
-
listeners() public
Возвращает список всех слушателей для eventKey в порядке, в котором они должны вызываться
-
off() public
Удаляет слушателя из активных слушателей.
-
on() public
Добавляет нового слушателя к событию.
Подробное описание методов
dispatch() public
dispatch(stringCake\Event\EventInterface $event): Cake\Event\EventInterface
Отправляет новое событие всем настроенным слушателям
Параметры
-
stringCake\Event\EventInterface$event Имя ключа события или экземпляр EventInterface.
Возвращает
Cake\Event\EventInterfacelisteners() public
listeners(string $eventKey): array
Возвращает список всех слушателей для eventKey в порядке, в котором они должны вызываться
Параметры
-
string$eventKey Ключ события.
Возвращает
arrayoff() public
off(stringCake\Event\EventListenerInterface|callable $eventKey, Cake\Event\EventListenerInterface|callable|null $callable = null): $this
Удаляет слушателя из активных слушателей.
Полное удаление EventListenerInterface:
$manager->off($listener);
Удаление всех слушателей для заданного события:
$manager->off('My.event'); Удаление конкретного слушателя:
$manager->off('My.event', $callback); Удаление обратного вызова со всех событий:
$manager->off($callback);
Параметры
-
stringCake\Event\EventListenerInterface|callable$eventKey Уникальное имя идентификатора события, с которым связан обратный вызов, или $listener, который требуется удалить.
-
Cake\Event\EventListenerInterface|callable|null$callable optional Обратный вызов, который требуется отсоединить.
Возвращает
$thison() public
on(stringCake\Event\EventListenerInterface $eventKey, array|callable $options = [], callable|null $callable = null): $this
Добавляет нового слушателя к событию.
Многофункциональный интерфейс для добавления слушателей, который имитирует jQuery.on().
Связывание EventListenerInterface:
$eventManager->on($listener);
Связывание без опций:
$eventManager->on('Model.beforeSave', $callable); Связывание с опциями:
$eventManager->on('Model.beforeSave', ['priority' => 90], $callable); Параметры
-
stringCake\Event\EventListenerInterface$eventKey Уникальное имя идентификатора события, с которым будет связан обратный вызов. Если $eventKey является экземпляром Cake\Event\EventListenerInterface, его события будут связаны с помощью методов
implementedEvents.-
array|callable$options optional Массив опций или обратный вызов, который нужно привязать к $eventKey. Если массив опций, то ключ
priorityможет быть использован для определения порядка. Приоритеты рассматриваются как очереди. Более низкие значения вызываются до более высоких, и несколько подключений, добавленных в одну очередь с тем же приоритетом, будут обработаны в порядке вставки.-
callable|null$callable optional Вызываемая функция.
Возвращает
$thisИсключение
InvalidArgumentExceptionПри отсутствии ключа события или если обратный вызов не является экземпляром Cake\Event\EventListenerInterface.
© 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.2/interface-Cake.Event.EventManagerInterface.html