Spec-Zone.ru › Laravel 6

Диспечер

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

Трейты

Макрообъект

Свойства

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

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

из Макрообъекта
защищенный Контейнер $container

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

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

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

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

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

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

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

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

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

Методы

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

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

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

from Macroable
mixed __call(string $method, array $parameters)

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

from Macroable
void __construct(Container $container = null)

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

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

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

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 $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()

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

Factory resolveQueue()

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

$this setQueueResolver(callable $resolver)

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

Details

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

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

Parameters

string $name
object|callable $macro

Return Value

void

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

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Container $container = null)

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

Parameters

Container $container

Return Value

void

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

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

Parameters

string|array $events
Closure|string $listener

Return Value

void

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

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

Parameters

string $event
Closure|string $listener

Return Value

void

bool hasListeners(string $eventName)

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

Parameters

string $eventName

Return Value

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

массив getListeners(строка $eventName)

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

Параметры

строка $eventName

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

массив

защищённый массив getWildcardListeners(строка $eventName)

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

Параметры

строка $eventName

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

массив

защищённый массив addInterfaceListeners(строка $eventName, массив $listeners = [])

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

Параметры

строка $eventName
массив $listeners

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

массив

Closure makeListener(Closure|строка $listener, bool $wildcard = false)

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

Параметры

Closure|строка $listener
bool $wildcard

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

Closure

Closure createClassListener(строка $listener, bool $wildcard = false)

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

Параметры

строка $listener
bool $wildcard

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

Closure

защищённый вызываемый объект createClassCallable(строка $listener)

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

Параметры

строка $listener

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

вызываемый объект

защищённый массив parseClassCallable(строка $listener)

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

Параметры

строка $listener

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

массив

защищённый bool handlerShouldBeQueued(строка $class)

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

Параметры

строка $class

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

bool

защищённый Closure createQueuedHandlerCallable(строка $class, строка $method)

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

Параметры

строка $class
строка $method

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

Closure

защищённый bool handlerWantsToBeQueued(строка $class, массив $arguments)

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

Параметры

строка $class
массив $arguments

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

bool

защищённый void queueHandler(строка $class, строка $method, массив $arguments)

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

Параметры

строка $class
строка $method
массив $arguments

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

void

защищённый массив createListenerAndJob(строка $class, строка $method, массив $arguments)

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

Параметры

строка $class
строка $method
массив $arguments

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

массив

защищённый смешанный propagateListenerOptions(смешанный $listener, смешанный $job)

Распространить опции слушателя на задачу.

Параметры

смешанный $listener
смешанный $job

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

смешанный

void forget(строка $event)

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

Параметры

строка $event

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

void

void forgetPushed()

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

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

void

защищённый Factory resolveQueue()

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

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

Factory

$this setQueueResolver(вызываемый объект $resolver)

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

Параметры

вызываемый объект $resolver

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

$this

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

Spec-Zone.ru

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