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) | ||
| массив | getListeners(string $eventName = null) Получает слушателей конкретного события или всех слушателей, отсортированных по убыванию приоритета. | |
| bool | hasListeners(string $eventName = null) Проверяет, есть ли у события зарегистрированные слушатели. |
Подробности
Event dispatch(string $eventName, Event $event = null)
Распространяет событие всем зарегистрированным слушателям.
Параметры
| строка | $eventName | Имя события для распространения. Имя события — имя метода, вызываемого у слушателей. |
| Event | $event | событие, передаваемое обработчикам/слушателям событий. Если не указано, создается пустой экземпляр события |
Значение результата
| Event |
addListener(string $eventName, callable $listener, int $priority)
Добавляет слушателя событий, который слушает указанные события.
Параметры
| строка | $eventName | Событие для прослушивания |
| callable | $listener | Слушатель |
| целое | $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 | Имя события |
Значение результата
| массив | Слушатели событий для указанного события или все слушатели событий по имени события |
bool hasListeners(string $eventName = null)
Проверяет, есть ли у события зарегистрированные слушатели.
Параметры
| строка | $eventName | Имя события |
Значение результата
| bool | true, если у указанного события есть слушатели, иначе false |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/EventDispatcher/EventDispatcherInterface.html
