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.1/Symfony/Component/EventDispatcher/EventDispatcherInterface.html