Spec-Zone.ru › CakePHP 3.8

Интерфейс EventManagerInterface

Интерфейс EventManagerInterface

Прямые реализаторы

  • Cake\Event\EventManager
Пространство имён: Cake\Event
Расположение: Event/EventManagerInterface.php

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

  • 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

Вызывает

$event

listeners()source public

listeners( string $eventKey )

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

Параметры

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

Возвращает

array

off()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 $callable optional 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 $eventKey optional null

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

array|callable $options optional []

Либо массив опций, либо обратный вызов, который нужно привязать к $eventKey. Если массив опций, то ключ priority может быть использован для определения порядка. Приоритеты обрабатываются как очереди. Более низкие значения вызываются до более высоких, и несколько прикреплений, добавленных в одну очередь с одинаковым приоритетом, будут обработаны в порядке вставки.

callable|null $callable optional 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

Spec-Zone.ru

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