Spec-Zone.ru › Laravel 8

Диспечер

класс Dispatcher реализует Диспечер (Посмотреть исходный код)

Трейты

Macroable
ReflectsClosures

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

из Macroable
защищённый Контейнер $container

Экземпляр контейнера IoC.

защищённый массив $listeners

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

защищённый массив $wildcards

Слушатели с подстановочными знаками.

защищённый массив $wildcardsCache

Кэшированные слушатели с подстановочными знаками.

защищённый вызываемый объект $queueResolver

Экземпляр обработчика очереди.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

из Macroable
static void mixin(object $mixin, bool $replace = true)

Включить другой объект в класс.

из Macroable
static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

из Macroable
static void flushMacros()

Очистить существующие макросы.

из Macroable
static mixed __callStatic(string $method, array $parameters)

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

из Macroable
mixed __call(string $method, array $parameters)

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

из Macroable
string firstClosureParameterType(Closure $closure)

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

из ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

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

из ReflectsClosures
array closureParameterTypes(Closure $closure)

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

из ReflectsClosures
void __construct(Container $container = null)

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

void listen(Closure|string|array $events, Closure|string|array|null $listener = null)

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

void setupWildcardListen(string $event, Closure|string $listener)

Настроить обработчик обратного вызова с подстановочными знаками.

bool hasListeners(string $eventName)

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

bool hasWildcardListeners(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|array $listener, bool $wildcard = false)

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

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

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

callable createClassCallable(array|string $listener)

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

array parseClassCallable(string $listener)

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

bool handlerShouldBeQueued(string $class)

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

Closure createQueuedHandlerCallable(string $class, string $method)

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

bool handlerShouldBeDispatchedAfterDatabaseTransactions(object|mixed $listener)

Определить, должен ли данный обработчик событий отправляться после фиксации всех транзакций базы данных.

Closure createCallbackForListenerRunningAfterCommits(mixed $listener, 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)

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

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Параметры

string $name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

protected string firstClosureParameterType(Closure $closure)

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

Параметры

Closure $closure

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

string

Исключения

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

Получить имена классов первого параметра заданного Closure, включая типы объединений.

Параметры

Closure $closure

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

array

Исключения

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

Получить имена классов/типы параметров заданного Closure.

Параметры

Closure $closure

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

array

Исключения

ReflectionException

void __construct(Container $container = null)

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

Параметры

Container $container

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

void

void listen(Closure|string|array $events, Closure|string|array|null $listener = null)

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

Параметры

Closure|string|array $events
Closure|string|array|null $listener

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

void

protected void setupWildcardListen(string $event, Closure|string $listener)

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

Параметры

string $event
Closure|string $listener

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

void

bool hasListeners(string $eventName)

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

Параметры

string $eventName

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

bool

bool hasWildcardListeners(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|array $listener, bool $wildcard = false)

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

Parameters

Closure|string|array $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(array|string $listener)

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

Parameters

array|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
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $class
string $method

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

Closure

protected bool handlerShouldBeDispatchedAfterDatabaseTransactions(object|mixed $listener)

Определить, должен ли данный обработчик событий быть обработан после завершения всех транзакций базы данных.

Параметры

object|mixed $listener

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

bool

protected Closure createCallbackForListenerRunningAfterCommits(mixed $listener, string $method)

Создать вызываемый объект для запуска слушателя после транзакций базы данных.

Параметры

mixed $listener
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/8.x/Illuminate/Events/Dispatcher.html

Spec-Zone.ru

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