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