Spec-Zone.ru › Symfony 4.1

EventDispatcherInterface

интерфейс EventDispatcherInterface

EventDispatcherInterface — центральная точка системы обработчиков событий Symfony.

Обработчики регистрируются в менеджере, а события отправляются через менеджер.

Методы

Event dispatch(string $eventName, Event $event = null)

Отправляет событие всем зарегистрированным обработчикам.

addListener(string $eventName, callable $listener, int $priority = 0)

Добавляет обработчик событий, который реагирует на указанные события.

addSubscriber(EventSubscriberInterface $subscriber)

Добавляет подписчика на события.

removeListener(string $eventName, callable $listener)

Удаляет обработчик события из указанных событий.

removeSubscriber(EventSubscriberInterface $subscriber)
array getListeners(string $eventName = null)

Возвращает обработчики событий для конкретного события или все обработчики событий, отсортированные по убыванию приоритета.

int|null getListenerPriority(string $eventName, callable $listener)

Возвращает приоритет обработчика для конкретного события.

bool hasListeners(string $eventName = null)

Проверяет, есть ли для события зарегистрированные обработчики.

Подробное описание

Event dispatch(string $eventName, Event $event = null)

Отправляет событие всем зарегистрированным обработчикам.

Параметры

string $eventName Имя события, которое необходимо отправить. Имя события — это имя метода, вызываемого у обработчиков.
Event $event Передаваемое событие обработчикам. Если не указано, создается пустой экземпляр события.

Возвращаемое значение

Event

addListener(string $eventName, callable $listener, int $priority = 0)

Добавляет обработчик события, который реагирует на указанные события.

Параметры

string $eventName Событие, на которое нужно реагировать
callable $listener Обработчик
int $priority Чем выше это значение, тем раньше обработчик события будет запущен в цепочке (по умолчанию 0)

addSubscriber(EventSubscriberInterface $subscriber)

Добавляет подписчика на события.

Подписчику задаются все события, к которым он заинтересован, и добавляется как обработчик для этих событий.

Параметры

EventSubscriberInterface $subscriber

removeListener(string $eventName, callable $listener)

Удаляет обработчик события из указанных событий.

Параметры

string $eventName Событие, из которого нужно удалить обработчик
callable $listener Обработчик, который нужно удалить

removeSubscriber(EventSubscriberInterface $subscriber)

Параметры

EventSubscriberInterface $subscriber

array getListeners(string $eventName = null)

Возвращает обработчики событий для конкретного события или все обработчики событий, отсортированные по убыванию приоритета.

Параметры

string $eventName Имя события

Возвращаемое значение

array Обработчики событий для указанного события или все обработчики событий по имени события

int|null getListenerPriority(string $eventName, callable $listener)

Возвращает приоритет обработчика для конкретного события.

Возвращает null, если события или обработчика не существует.

Параметры

string $eventName Имя события
callable $listener Обработчик

Возвращаемое значение

int|null Приоритет обработчика событий

bool hasListeners(string $eventName = null)

Проверяет, есть ли для события зарегистрированные обработчики.

Параметры

string $eventName Имя события

Возвращаемое значение

bool true, если для указанного события есть обработчики, иначе false

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/EventDispatcher/EventDispatcherInterface.html

Spec-Zone.ru

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