EventDispatcherInterface
интерфейс EventDispatcherInterface
EventDispatcherInterface — центральная точка системы обработчиков событий Symfony.
Обработчики регистрируются в менеджере, а события отправляются через менеджер.
Методы
| Событие | dispatch(string $eventName, Событие $event = null) Отправляет событие всем зарегистрированным обработчикам. | |
| addListener(string $eventName, callable $listener, int $priority) Добавляет обработчик событий, который реагирует на указанные события. | ||
| addSubscriber(EventSubscriberInterface $subscriber) Добавляет подписчика на события. | ||
| removeListener(string $eventName, callable $listener) Удаляет обработчик событий для указанных событий. | ||
| removeSubscriber(EventSubscriberInterface $subscriber) | ||
| массив | getListeners(string $eventName = null) Получает обработчики конкретного события или все обработчики, отсортированные по убыванию приоритета. | |
| int|null | getListenerPriority(string $eventName, callable $listener) Получает приоритет обработчика для конкретного события. | |
| bool | hasListeners(string $eventName = null) Проверяет, имеет ли событие зарегистрированные обработчики. |
Подробности
Событие dispatch(string $eventName, Событие $event = null)
Отправляет событие всем зарегистрированным обработчикам.
Параметры
| строка | $eventName | Имя события для отправки. Имя события — имя метода, вызываемого у обработчиков. |
| Событие | $event | Событие для передачи обработчикам/слушателям. Если не указано, создается пустой экземпляр события |
Возвращаемое значение
| Событие |
addListener(string $eventName, callable $listener, int $priority)
Добавляет обработчик событий, реагирующий на указанные события.
Параметры
| строка | $eventName | Событие для реагирования |
| callable | $listener | Обработчик |
| int | $priority | Чем выше значение, тем раньше обработчик событий будет вызван в цепочке (по умолчанию 0) |
addSubscriber(EventSubscriberInterface $subscriber)
Добавляет подписчика на события.
Подписчику задаются все события, которые его интересуют, и он добавляется как обработчик для этих событий.
Параметры
| EventSubscriberInterface | $subscriber |
removeListener(string $eventName, callable $listener)
Удаляет обработчик событий для указанных событий.
Параметры
| строка | $eventName | Событие, из которого необходимо удалить обработчик |
| callable | $listener | Обработчик для удаления |
removeSubscriber(EventSubscriberInterface $subscriber)
Параметры
| EventSubscriberInterface | $subscriber |
массив getListeners(string $eventName = null)
Получает обработчики конкретного события или все обработчики, отсортированные по убыванию приоритета.
Параметры
| строка | $eventName | Имя события |
Возвращаемое значение
| массив | Обработчики событий для указанного события или все обработчики событий по имени события |
int|null getListenerPriority(string $eventName, callable $listener)
Получает приоритет обработчика для конкретного события.
Возвращает null, если событие или обработчик не существует.
Параметры
| строка | $eventName | Имя события |
| callable | $listener | Обработчик |
Возвращаемое значение
| int|null | Приоритет обработчика событий |
bool hasListeners(string $eventName = null)
Проверяет, имеет ли событие зарегистрированные обработчики.
Параметры
| строка | $eventName | Имя события |
Возвращаемое значение
| bool | true, если указанное событие имеет обработчики, false в противном случае |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/EventDispatcher/EventDispatcherInterface.html
