Spec-Zone.ru › Symfony 3.2

EventDispatcher

class EventDispatcher implements EventDispatcherInterface

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

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

Методы

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

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

array getListeners(string $eventName = null)

Получает обработчики конкретного события или все обработчики, отсортированные по убыванию приоритета.

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

Получает приоритет обработчика для конкретного события.

bool hasListeners(string $eventName = null)

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

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

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

removeListener(string $eventName, callable $listener)

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

addSubscriber(EventSubscriberInterface $subscriber)

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

removeSubscriber(EventSubscriberInterface $subscriber)

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

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

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

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

Параметры

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

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

Event

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

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

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

Параметры

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

removeListener(string $eventName, callable $listener)

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

Параметры

string $eventName Событие для удаления обработчика
callable $listener Обработчик для удаления

addSubscriber(EventSubscriberInterface $subscriber)

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

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

Параметры

EventSubscriberInterface $subscriber Подписчик

removeSubscriber(EventSubscriberInterface $subscriber)

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

Параметры

EventSubscriberInterface $subscriber Подписчик

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

Spec-Zone.ru

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