Диспечер

класс Dispatcher реализует Dispatcher (View source)

Свойства

protected Container	$container	Экземпляр контейнера IoC.
protected array	$listeners	Зарегистрированные обработчики событий.
protected array	$wildcards	Обработчики с подстановкой.
protected array	$wildcardsCache	Кэшированные обработчики с подстановкой.
protected callable	$queueResolver	Экземпляр решателя очереди.

Методы

void

__construct(Container $container = null)

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

void

listen(string|array $events, mixed $listener)

Зарегистрировать обработчик событий в диспечере.

void

setupWildcardListen(string $event, mixed $listener)

Настроить обработчик с подстановкой.

bool

hasListeners(string $eventName)

Определить, есть ли обработчики для данного события.

void

push(string $event, array $payload = [])

Зарегистрировать событие и полезную нагрузку для последующего срабатывания.

void

flush(string $event)

Очистить набор отложенных событий.

void

subscribe(object|string $subscriber)

Зарегистрировать подписчика на события в диспечере.

mixed

resolveSubscriber(object|string $subscriber)

Разрешить экземпляр подписчика.

array|null

until(string|object $event, mixed $payload = [])

Вызвать событие до получения первого ненулевого ответа.

array|null

dispatch(string|object $event, mixed $payload = [], bool $halt = false)

Вызвать событие и вызвать обработчики.

array

parseEventAndPayload(mixed $event, mixed $payload)

Разбирать заданное событие и полезную нагрузку для отправки.

bool

shouldBroadcast(array $payload)

Определить, содержит ли полезная нагрузка транслируемое событие.

bool

broadcastWhen(mixed $event)

Проверить, нужно ли транслировать событие по условию.

void

broadcastEvent(ShouldBroadcast $event)

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

array

getListeners(string $eventName)

Получить все обработчики для данного имени события.

array

getWildcardListeners(string $eventName)

Получить обработчики с подстановкой для события.

array

addInterfaceListeners(string $eventName, array $listeners = [])

Добавить обработчики для интерфейсов события в заданный массив.

Closure

makeListener(Closure|string $listener, bool $wildcard = false)

Зарегистрировать обработчик события в диспечере.

Closure

createClassListener(string $listener, bool $wildcard = false)

Создать обработчик на основе класса с использованием контейнера IoC.

callable

createClassCallable(string $listener)

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

array

parseClassCallable(string $listener)

Разбирать обработчик класса на класс и метод.

bool

handlerShouldBeQueued(string $class)

Определить, должен ли обработчик события быть помещен в очередь.

Closure

createQueuedHandlerCallable(string $class, string $method)

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

bool

handlerWantsToBeQueued(string $class, array $arguments)

Определить, хочет ли обработчик события быть помещен в очередь.

void

queueHandler(string $class, string $method, array $arguments)

Поместить обработчик класса в очередь.

array

createListenerAndJob(string $class, string $method, array $arguments)

Создать обработчик и задачу для обработчика в очереди.

mixed

propagateListenerOptions(mixed $listener, mixed $job)

Распространить параметры обработчика на задачу.

void

forget(string $event)

Удалить набор обработчиков из диспечера.

void

forgetPushed()

Удалить все отложенные обработчики.

Queue

resolveQueue()

Получить реализацию очереди из решателя.

$this

setQueueResolver(callable $resolver)

Установить реализацию решателя очереди.

Подробности

void __construct(Container $container = null)

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

Параметры

Container

$container

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

void

void listen(string|array $events, mixed $listener)

Зарегистрировать обработчик события в диспечере.

Параметры

string\|array	$events
mixed	$listener

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

void

protected void setupWildcardListen(string $event, mixed $listener)

Настроить обработчик с подстановкой.

Параметры

string	$event
mixed	$listener

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

void

bool hasListeners(string $eventName)

Определить, есть ли слушатели для данного события.

Parameters

string

$eventName

Return Value

bool

void push(string $event, array $payload = [])

Зарегистрировать событие и полезную нагрузку для последующего срабатывания.

Parameters

string	$event
array	$payload

Return Value

void

void flush(string $event)

Очистить набор зарегистрированных событий.

Parameters

string

$event

Return Value

void

void subscribe(object|string $subscriber)

Зарегистрировать подписчика на событие в диспетчер.

Parameters

object|string

$subscriber

Return Value

void

protected mixed resolveSubscriber(object|string $subscriber)

Разрешить экземпляр подписчика.

Parameters

object|string

$subscriber

Return Value

mixed

array|null until(string|object $event, mixed $payload = [])

Срабатывать события до получения первого ненулевого ответа.

Parameters

string\|object	$event
mixed	$payload

Return Value

array|null

array|null dispatch(string|object $event, mixed $payload = [], bool $halt = false)

Сгенерировать событие и вызвать слушателей.

Parameters

string\|object	$event
mixed	$payload
bool	$halt

Return Value

array|null

protected array parseEventAndPayload(mixed $event, mixed $payload)

Разбирать событие и полезную нагрузку для подготовки к срабатыванию.

Parameters

mixed	$event
mixed	$payload

Return Value

array

protected bool shouldBroadcast(array $payload)

Определить, содержит ли полезная нагрузка событие для трансляции.

Parameters

array

$payload

Return Value

bool

protected bool broadcastWhen(mixed $event)

Проверить, должно ли событие быть транслировано по условию.

Parameters

mixed

$event

Return Value

bool

protected void broadcastEvent(ShouldBroadcast $event)

Транслировать заданный класс события.

Parameters

ShouldBroadcast

$event

Return Value

void

array getListeners(string $eventName)

Получить всех слушателей для данного имени события.

Parameters

string

$eventName

Return Value

array

protected array getWildcardListeners(string $eventName)

Получить слушателей с подстановкой для события.

Parameters

string

$eventName

Return Value

array

protected array addInterfaceListeners(string $eventName, array $listeners = [])

Добавить слушателей для интерфейсов события в заданный массив.

Parameters

string	$eventName
array	$listeners

Return Value

array

Closure makeListener(Closure|string $listener, bool $wildcard = false)

Зарегистрировать слушателя события в диспетчере.

Parameters

Closure\|string	$listener
bool	$wildcard

Return Value

Closure

Closure createClassListener(string $listener, bool $wildcard = false)

Создать слушателя на основе класса, используя контейнер IoC.

Parameters

string	$listener
bool	$wildcard

Return Value

Closure

protected callable createClassCallable(string $listener)

Создать вызываемый объект на основе класса.

Parameters

string

$listener

Return Value

callable

protected array parseClassCallable(string $listener)

Разбор слушателя класса в класс и метод.

Parameters

string

$listener

Return Value

array

protected bool handlerShouldBeQueued(string $class)

Определить, должен ли обработчик события быть помещён в очередь.

Parameters

string

$class

Return Value

bool

protected Closure createQueuedHandlerCallable(string $class, string $method)

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

Параметры

string	$class
string	$method

Значение возврата

Closure

protected bool handlerWantsToBeQueued(string $class, array $arguments)

Определите, хочет ли обработчик событий быть помещен в очередь.

Параметры

string	$class
array	$arguments

Значение возврата

bool

protected void queueHandler(string $class, string $method, array $arguments)

Поместите класс обработчика в очередь.

Параметры

string	$class
string	$method
array	$arguments

Значение возврата

void

protected array createListenerAndJob(string $class, string $method, array $arguments)

Создайте слушателя и задание для слушателя в очереди.

Параметры

string	$class
string	$method
array	$arguments

Значение возврата

array

protected mixed propagateListenerOptions(mixed $listener, mixed $job)

Распространите параметры слушателя на задание.

Параметры

mixed	$listener
mixed	$job

Значение возврата

mixed

void forget(string $event)

Удалите набор слушателей из диспетчера.

Параметры

string

$event

Значение возврата

void

void forgetPushed()

Забудьте всех помещенных слушателей.

Значение возврата

void

protected Queue resolveQueue()

Получите реализацию очереди из решателя.

Значение возврата

Queue

$this setQueueResolver(callable $resolver)

Установите реализацию решателя очереди.

Параметры

callable

$resolver

Значение возврата

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Events/Dispatcher.html