Spec-Zone.ru › Symfony 2.8

ContainerAwareEventDispatcher

class ContainerAwareEventDispatcher extends EventDispatcher

Лениво загружает слушателей и подписчиков из контейнера инъекции зависимостей.

Методы

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

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

from EventDispatcher
array getListeners(string $eventName = null)

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

int|null getListenerPriority(string $eventName, callable $listener)

Получает приоритет слушателя для определенного события.

bool hasListeners(string $eventName = null)

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

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

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

from EventDispatcher
removeListener(string $eventName, callable $listener)

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

addSubscriber(EventSubscriberInterface $subscriber)

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

from EventDispatcher
removeSubscriber(EventSubscriberInterface $subscriber) from EventDispatcher
__construct(ContainerInterface $container)
addListenerService(string $eventName, array $callback, int $priority)

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

addSubscriberService(string $serviceId, string $class)

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

getContainer()

Подробности

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)

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

Параметры

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

__construct(ContainerInterface $container)

Параметры

ContainerInterface $container

addListenerService(string $eventName, array $callback, int $priority)

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

Параметры

string $eventName Событие, для которого добавляется слушатель
array $callback ID сервиса слушателя и имя метода, который должен быть вызван
int $priority Чем выше это значение, тем раньше слушатель событий будет срабатывать в цепочке. По умолчанию 0.

Исключения

InvalidArgumentException

addSubscriberService(string $serviceId, string $class)

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

Параметры

string $serviceId ID сервиса подписчика
string $class Имя класса сервиса (который должен реализовывать EventSubscriberInterface)

getContainer()

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

Spec-Zone.ru

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