BroadcastEvent

class BroadcastEvent implements ShouldQueue (View source)

Трейты

Свойства

string\|null	$connection	Имя подключения, к которому должно быть отправлено задание.	из Queueable
string\|null	$queue	Имя очереди, к которой должно быть отправлено задание.	из Queueable
DateTimeInterface\|DateInterval\|array\|int\|null	$delay	Количество секунд, которое должно пройти перед тем, как задание станет доступным.	из Queueable
bool\|null	$afterCommit	Указывает, должно ли задание быть отправлено после завершения всех баз данных транзакций.	из Queueable
array	$middleware	Средства обработки, через которые должно быть отправлено задание.	из Queueable
array	$chained	Задания, которые должны выполняться, если это задание выполнено успешно.	из Queueable
string\|null	$chainConnection	Имя подключения, к которому должна быть отправлена цепочка.	из Queueable
string\|null	$chainQueue	Имя очереди, к которой должна быть отправлена цепочка.	из Queueable
array\|null	$chainCatchCallbacks	Обработчики, которые должны быть выполнены при ошибке цепочки.	из Queueable
mixed	$event	Экземпляр события.
int	$tries	Количество попыток выполнения задания.
int	$timeout	Количество секунд, в течение которых задание может выполняться, прежде чем истечет время ожидания.
int	$backoff	Количество секунд ожидания перед повторной попыткой выполнения задания при возникновении необработанного исключения.
int	$maxExceptions	Максимальное количество необработанных исключений, разрешенных перед ошибкой.

Методы

$this

onConnection(string|null $connection)

Установите желаемое подключение для задачи.

из Queueable

$this

onQueue(string|null $queue)

Установите желаемую очередь для задачи.

из Queueable

$this

allOnConnection(string|null $connection)

Установите желаемое подключение для цепочки.

из Queueable

$this

allOnQueue(string|null $queue)

Установите желаемую очередь для цепочки.

из Queueable

$this

delay(DateTimeInterface|DateInterval|array|int|null $delay)

Установите желаемую задержку в секундах для задачи.

из Queueable

$this

withoutDelay()

Установите задержку для задачи в ноль секунд.

из Queueable

$this

afterCommit()

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

из Queueable

$this

beforeCommit()

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

из Queueable

$this

through(array|object $middleware)

Укажите, через какой middleware должна быть отправлена задача.

из Queueable

$this

chain(array $chain)

Установите задачи, которые должны выполняться, если эта задача выполнена успешно.

из Queueable

$this

prependToChain(mixed $job)

Добавить задачу в начало текущей цепочки, чтобы она выполнялась после текущей задачи.

из Queueable

$this

appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

из Queueable

string

serializeJob(mixed $job)

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

из Queueable

void

dispatchNextJobInChain()

Отправить следующую задачу в цепочке.

из Queueable

void

invokeChainCatchCallbacks(Throwable $e)

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

из Queueable

void

assertHasChain(array $expectedChain)

Утверждение, что задача имеет заданную цепочку прикрепленных к ней задач.

из Queueable

void

assertDoesntHaveChain()

Утверждение, что у задачи нет оставшихся задач в цепочке.

из Queueable

void

__construct(mixed $event)

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

void

handle(Factory $manager)

Обработать задачу в очереди.

array

getPayloadFromEvent(mixed $event)

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

mixed

formatProperty(mixed $value)

Отформатировать заданное значение для свойства.

string

displayName()

Получить имя отображения задачи в очереди.

void

__clone()

Подготовить экземпляр к клонированию.

Подробности

$this onConnection(string|null $connection)

Установите желаемое подключение для задачи.

Параметры

string|null

$connection

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

$this

$this onQueue(string|null $queue)

Установите желаемую очередь для задачи.

Параметры

string|null

$queue

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

$this

$this allOnConnection(string|null $connection)

Установите желаемое подключение для цепочки.

Параметры

string|null

$connection

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

$this

$this allOnQueue(string|null $queue)

Установите желаемую очередь для цепочки.

Параметры

string|null

$queue

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

$this

$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Установите желаемую задержку в секундах для задачи.

Параметры

DateTimeInterface|DateInterval|array|int|null

$delay

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

$this

$this withoutDelay()

Установите задержку для задачи в ноль секунд.

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

$this

$this afterCommit()

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

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

$this

$this beforeCommit()

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

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

$this

$this through(array|object $middleware)

Укажите промежуточное ПО, через которое должно быть отправлено задание.

Parameters

array|object

$middleware

Return Value

$this

$this chain(array $chain)

Установите задачи, которые должны выполняться, если данная задача завершится успешно.

Parameters

array

$chain

Return Value

$this

$this prependToChain(mixed $job)

Вставить задачу в начало текущей цепочки, чтобы она выполнялась после текущей задачи.

Parameters

mixed

$job

Return Value

$this

$this appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

Parameters

mixed

$job

Return Value

$this

protected string serializeJob(mixed $job)

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

Parameters

mixed

$job

Return Value

string

Exceptions

RuntimeException

void dispatchNextJobInChain()

Отправить следующую задачу в цепочке.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

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

Parameters

Throwable

Return Value

void

void assertHasChain(array $expectedChain)

Утверждение, что у задания есть заданная цепочка задач.

Parameters

array

$expectedChain

Return Value

void

void assertDoesntHaveChain()

Утверждение, что у задания нет оставшихся задач в цепочке.

Return Value

void

void __construct(mixed $event)

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

Parameters

mixed

$event

Return Value

void

void handle(Factory $manager)

Обработать задание в очереди.

Parameters

Factory

$manager

Return Value

void

protected array getPayloadFromEvent(mixed $event)

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

Parameters

mixed

$event

Return Value

array

protected mixed formatProperty(mixed $value)

Отформатировать данное значение для свойства.

Parameters

mixed

$value

Return Value

mixed

string displayName()

Получить отображаемое имя для задания в очереди.

Return Value

string

void __clone()

Подготовить экземпляр для клонирования.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Broadcasting/BroadcastEvent.html