ExtractingEventDispatcher

Event dispatch(string $eventName, Event $event = null)

Отправляет событие всем зарегистрированным слушателям.

Параметры

string	$eventName	Имя события для отправки. Имя события — это имя метода, который вызывается у слушателей.
Event	$event	Событие для передачи обработчикам/слушателям. Если не указано, создается пустой экземпляр Event.

Возвращаемое значение

Event

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 в противном случае

addListener(string $eventName, callable $listener, int $priority = 0)

Добавляет слушателя события, который слушает указанные события.

Параметры

string	$eventName	Событие, на которое нужно подписаться
callable	$listener	Слушатель
int	$priority	Чем выше это значение, тем раньше слушатель события будет активирован в цепочке (по умолчанию 0)

removeListener(string $eventName, callable $listener)

Удаляет слушателя события из указанных событий.

Параметры

string	$eventName	Событие, из которого нужно удалить слушателя
callable	$listener	Слушатель для удаления

addSubscriber(EventSubscriberInterface $subscriber)

Добавляет подписчика на события.

Подписчику запрашиваются все события, на которые он подписан, и добавляются как слушатели для этих событий.

Параметры

EventSubscriberInterface

$subscriber

removeSubscriber(EventSubscriberInterface $subscriber)

Параметры

EventSubscriberInterface

$subscriber

protected doDispatch(callable[] $listeners, string $eventName, Event $event)

Вызывает слушателей события.

Этот метод можно переопределить, чтобы добавить функциональность, которая выполняется для каждого слушателя.

Параметры

callable[]	$listeners	Слушатели событий
string	$eventName	Имя события, которое нужно отправить
Event	$event	Объект события, который нужно передать обработчикам/слушателям

static array getSubscribedEvents()

Возвращает массив имен событий, на которые этот подписчик хочет подписаться.

Ключи массива — имена событий, а значение может быть:

• Имя вызываемого метода (приоритет по умолчанию 0)
• Массив, состоящий из имени вызываемого метода и приоритета
• Массив массивов, состоящих из имен вызываемых методов и соответствующих приоритетов, или 0, если не задано

Например:

• array('eventName' => 'methodName')
• array('eventName' => array('methodName', $priority))
• array('eventName' => array(array('methodName1', $priority), array('methodName2')))

Возвращаемое значение

array

Имена событий, на которые нужно подписаться