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