ImmutableEventDispatcher
class ImmutableEventDispatcher implements EventDispatcherInterface
Только для чтения прокси для диспетчера событий.
Методы
| __construct(EventDispatcherInterface $dispatcher) | ||
| Event | dispatch(string $eventName, Event $event = null) Отправляет событие всем зарегистрированным обработчикам. | |
| addListener(string $eventName, callable $listener, int $priority = 0) Добавляет обработчик событий, который слушает указанные события. | ||
| 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) Проверяет, есть ли у события зарегистрированные обработчики. |
Подробности
__construct(EventDispatcherInterface $dispatcher)
Параметры
| EventDispatcherInterface | $dispatcher |
Event dispatch(string $eventName, Event $event = null)
Отправляет событие всем зарегистрированным обработчикам.
Параметры
| string | $eventName | Имя события для отправки. Имя события — это имя метода, который вызывается у обработчиков. |
| Event | $event | Событие для передачи обработчикам/слушателям. Если не указано, создается пустой экземпляр события |
Возвращаемое значение
| Event |
addListener(string $eventName, callable $listener, int $priority = 0)
Добавляет обработчик событий, который слушает указанные события.
Параметры
| 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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/EventDispatcher/ImmutableEventDispatcher.html