TraceableEventDispatcherInterface
интерфейс TraceableEventDispatcherInterface реализует EventDispatcherInterface
Методы
| Event | dispatch(string $eventName, Event $event = null) Отправляет событие всем зарегистрированным слушателям. | из EventDispatcherInterface |
| addListener(string $eventName, callable $listener, int $priority) Добавляет слушателя событий, который прослушивает указанные события. | из EventDispatcherInterface | |
| addSubscriber(EventSubscriberInterface $subscriber) Добавляет подписчика на события. | из EventDispatcherInterface | |
| removeListener(string $eventName, callable $listener) Удаляет слушателя событий из указанных событий. | из EventDispatcherInterface | |
| removeSubscriber(EventSubscriberInterface $subscriber) | из EventDispatcherInterface | |
| array | getListeners(string $eventName = null) Получает слушателей конкретного события или всех слушателей, отсортированных по убыванию приоритета. | из EventDispatcherInterface |
| int|null | getListenerPriority(string $eventName, callable $listener) Получает приоритет слушателя для определенного события. | из EventDispatcherInterface |
| bool | hasListeners(string $eventName = null) Проверяет, имеет ли событие зарегистрированных слушателей. | из EventDispatcherInterface |
| array | getCalledListeners() Получает вызванные слушатели. | |
| array | getNotCalledListeners() Получает невызванные слушатели. | |
| reset() Сбрасывает трассировку. |
Подробное описание
Event dispatch(string $eventName, Event $event = null)
Отправляет событие всем зарегистрированным слушателям.
Параметры
| string | $eventName | Имя события для отправки. Имя события — это имя метода, вызываемого у слушателей. |
| Event | $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 |
array getCalledListeners()
Получает вызванные слушатели.
Возвращаемое значение
| array | Массив вызванных слушателей |
array getNotCalledListeners()
Получает невызванные слушатели.
Возвращаемое значение
| array | Массив невызванных слушателей |
reset()
Сбрасывает трассировку.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcherInterface.html