Spec-Zone.ru › Laravel 10

Диспечер

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

Трейты

Макрообъект
Отражает замыкания

Свойства

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

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

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

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

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

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

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

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

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

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

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

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

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

Экземпляр решателя менеджера транзакций базы данных.

Методы

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)

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

из ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

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

из ReflectsClosures
array closureParameterTypes(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)

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

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

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

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

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

array|null invokeListeners(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[] prepareListeners(string $eventName)

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

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, CallQueuedListener $job)

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

void forget(string $event)

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

void forgetPushed()

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

Queue resolveQueue()

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

$this setQueueResolver(callable $resolver)

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

DatabaseTransactionsManager|null resolveTransactionManager()

Получить реализацию менеджера транзакций базы данных из резолвера.

$this setTransactionManagerResolver(callable $resolver)

Установить реализацию резолвера менеджера транзакций базы данных.

array getRawListeners()

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

Подробности

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 void flushMacros()

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

Return Value

void

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

protected string firstClosureParameterType(Closure $closure)

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

Parameters

Closure $closure

Return Value

string

Exceptions

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

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

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

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

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException

void __construct(Container $container = null)

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

Parameters

Container $container

Return Value

void

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

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

Parameters

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

Return Value

void
END_OF_DOCUMENT_MARKER

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)

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

Параметры

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

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

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

Параметры

string|object $event
mixed $payload

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

mixed

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

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

Параметры

string|object $event
mixed $payload
bool $halt

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

array|null

protected array|null invokeListeners(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

protected Closure[] prepareListeners(string $eventName)

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

Параметры

string $eventName

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

Closure[]

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

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

Параметры

Closure|string|array $listener
bool $wildcard

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

Closure
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $listener
bool $wildcard

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

Closure

protected callable createClassCallable(array|string $listener)

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

Параметры

array|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 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, CallQueuedListener $job)

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

Параметры

mixed $listener
CallQueuedListener $job

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

mixed

void forget(string $event)

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

Параметры

string $event

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

void

void forgetPushed()

Удалить все добавленные слушатели.

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

void

protected Queue resolveQueue()

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

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

Queue

$this setQueueResolver(callable $resolver)

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

Параметры

callable $resolver

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

$this

protected DatabaseTransactionsManager|null resolveTransactionManager()

Получить реализацию менеджера транзакций базы данных из разрешителя.

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

DatabaseTransactionsManager|null

$this setTransactionManagerResolver(callable $resolver)

Установить реализацию разрешителя менеджера транзакций базы данных.

Параметры

callable $resolver

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

$this

array getRawListeners()

Получить исходные, необработанные слушатели.

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

array

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

Spec-Zone.ru

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