Spec-Zone.ru › Laravel 5.5

Диспечер

класс Dispatcher реализует Dispatcher (Просмотр исходного кода)

Свойства

protected Container $container Экземпляр контейнера IoC.
protected array $listeners Зарегистрированные обработчики событий.
protected array $wildcards Обработчики с подстановкой.
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 fire(string|object $event, mixed $payload = [], bool $halt = false)

Запустить событие и вызвать обработчики.

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)

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

Параметры

string $eventName

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

bool

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

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

Параметры

string $event
array $payload

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

void

void flush(string $event)

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

Параметры

string $event

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

void

void subscribe(object|string $subscriber)

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

Параметры

object|string $subscriber

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

void

protected mixed resolveSubscriber(object|string $subscriber)

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

Параметры

object|string $subscriber

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

mixed

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

Срабатывать событие до тех пор, пока не вернётся первый ненулевой ответ.

Параметры

string|object $event
mixed $payload

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

array|null

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

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

Параметры

string|object $event
mixed $payload
bool $halt

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

array|null

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

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

Параметры

string|object $event
mixed $payload
bool $halt

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

array|null

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

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

Параметры

mixed $event
mixed $payload

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

array

protected bool shouldBroadcast(array $payload)

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

Параметры

array $payload

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

bool

protected bool broadcastWhen(mixed $event)

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

Параметры

mixed $event

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

bool

protected void broadcastEvent(ShouldBroadcast $event)

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

Параметры

ShouldBroadcast $event

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

void

array getListeners(string $eventName)

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

Параметры

string $eventName

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

array

protected array getWildcardListeners(string $eventName)

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

Параметры

string $eventName

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

array

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

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

Параметры

string $eventName
array $listeners

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

array

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

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

Параметры

Closure|string $listener
bool $wildcard

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

Closure

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

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

Параметры

string $listener
bool $wildcard

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

Closure

protected callable createClassCallable(string $listener)

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

Параметры

string $listener

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

callable

protected array parseClassCallable(string $listener)

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

Параметры

string $listener

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

array

protected bool handlerShouldBeQueued(string $class)

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

Параметры

string $class

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

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.5/Illuminate/Events/Dispatcher.html

Spec-Zone.ru

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