EventDispatcherInterface
интерфейс EventDispatcherInterface
EventDispatcherInterface — центральная точка системы обработчиков событий Symfony.
Обработчики регистрируются в менеджере, а события передаются через менеджер.
Методы
| Event | dispatch(string $eventName, Event $event = null) Отправляет событие всем зарегистрированным обработчикам. | |
| addListener(string $eventName, callable $listener, int $priority) Добавляет обработчик событий, который реагирует на указанные события. | ||
| 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)
Добавляет обработчик событий, реагирующий на указанные события.
Параметры
| 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.
http://api.symfony.com/3.2/Symfony/Component/EventDispatcher/EventDispatcherInterface.html