Spec-Zone.ru › CakePHP 4.4

Интерфейс EventManagerInterface

Интерфейс EventManagerInterface

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

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

  • dispatch() public

    Отправляет новое событие всем настроенным слушателям

  • listeners() public

    Возвращает список всех слушателей для eventKey в порядке, в котором они должны вызываться

  • off() public

    Удаляет слушателя из активных слушателей.

  • on() public

    Добавляет нового слушателя к событию.

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

dispatch() public

dispatch(Cake\Event\EventInterface|string $event): Cake\Event\EventInterface

Отправляет новое событие всем настроенным слушателям

Параметры

Cake\Event\EventInterface|string $event

Имя ключа события или экземпляр EventInterface.

Возвращает

Cake\Event\EventInterface

listeners() public

listeners(string $eventKey): array

Возвращает список всех слушателей для eventKey в порядке, в котором они должны вызываться

Параметры

string $eventKey

Ключ события.

Возвращает

array

off() public

off(Cake\Event\EventListenerInterface|callable|string $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);

Параметры

Cake\Event\EventListenerInterface|callable|string $eventKey

Имя уникального идентификатора события, с которым связан обратный вызов, или $listener, который вы хотите удалить.

Cake\Event\EventListenerInterface|callable|null $callable optional

Обратный вызов, который вы хотите отключить.

Возвращает

$this

on() public

on(Cake\Event\EventListenerInterface|string $eventKey, callable|array $options = [], callable|null $callable = null): $this

Добавляет нового слушателя к событию.

Многопараметрический интерфейс для добавления слушателей, который имитирует jQuery.on().

Связывание EventListenerInterface:

$eventManager->on($listener);

Связывание без опций:

$eventManager->on('Model.beforeSave', $callable);

Связывание с опциями:

$eventManager->on('Model.beforeSave', ['priority' => 90], $callable);

Параметры

Cake\Event\EventListenerInterface|string $eventKey

Уникальное идентификаторное имя события, с которым будет связан обратный вызов. Если $eventKey является экземпляром Cake\Event\EventListenerInterface, его события будут связаны с помощью методов implementedEvents().

callable|array $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.4/interface-Cake.Event.EventManagerInterface.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API