TraceableEventDispatcher
class TraceableEventDispatcher implements TraceableEventDispatcherInterface
Собирает данные об обработчиках событий.
Этот обработчик событий делегирует обработку другому.
Методы
| __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = 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) Отправляет событие всем зарегистрированным обработчикам. | |
| array | getCalledListeners() Возвращает вызванные обработчики. | |
| array | getNotCalledListeners() Возвращает невызванные обработчики. | |
| reset() Сбрасывает трассировку. | ||
| mixed | __call(string $method, array $arguments) Делегирует все вызовы методов оригинальному обработчику событий. |
Подробности
__construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
Параметры
| EventDispatcherInterface | $dispatcher | |
| Stopwatch | $stopwatch | |
| LoggerInterface | $logger |
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 |
Event dispatch(string $eventName, Event $event = null)
Отправляет событие всем зарегистрированным обработчикам.
Параметры
| string | $eventName | Имя события для отправки. Имя события — это имя метода, вызываемого у обработчиков. |
| Event | $event | событие для передачи обработчикам/слушателям Если не указано, создается пустой экземпляр Event |
Возвращаемое значение
| Event |
array getCalledListeners()
Возвращает вызванные обработчики.
Возвращаемое значение
| array | Массив вызванных обработчиков |
array getNotCalledListeners()
Возвращает невызванные обработчики.
Возвращаемое значение
| array | Массив невызванных обработчиков |
reset()
Сбрасывает трассировку.
mixed __call(string $method, array $arguments)
Делегирует все вызовы методов оригинальному обработчику событий.
Параметры
| string | $method | Имя метода |
| array | $arguments | Аргументы метода |
Возвращаемое значение
| mixed |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.html