Spec-Zone.ru › Symfony 3.2

ImmutableEventDispatcher

class ImmutableEventDispatcher implements EventDispatcherInterface

Только для чтения прокси для диспетчера событий.

Методы

__construct(EventDispatcherInterface $dispatcher)

Создаёт неизменяемый прокси для диспетчера событий.

Event dispatch(string $eventName, Event $event = 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)

Проверяет, есть ли у события зарегистрированные слушатели.

Подробное описание

__construct(EventDispatcherInterface $dispatcher)

Создаёт неизменяемый прокси для диспетчера событий.

Параметры

EventDispatcherInterface $dispatcher Проксируемый диспетчер событий

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/EventDispatcher/ImmutableEventDispatcher.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API