BroadcastEvent
class BroadcastEvent implements ShouldQueue (View source)
Трейты
| Queueable |
Свойства
| string|null | $connection | Имя подключения, к которому должно быть отправлено задание. | из Queueable |
| string|null | $queue | Имя очереди, к которому должно быть отправлено задание. | из Queueable |
| string|null | $chainConnection | Имя подключения, к которому должна быть отправлена цепочка. | из Queueable |
| string|null | $chainQueue | Имя очереди, к которому должна быть отправлена цепочка. | из Queueable |
| array|null | $chainCatchCallbacks | Обработчики, которые должны быть выполнены при сбое цепочки. | из Queueable |
| DateTimeInterface|DateInterval|array|int|null | $delay | Количество секунд, которое должно пройти перед тем, как задание станет доступным. | из Queueable |
| bool|null | $afterCommit | Указывает, должно ли задание быть отправлено после завершения всех транзакций базы данных. | из Queueable |
| array | $middleware | Средства обработки, которые должно пройти задание при отправке. | из Queueable |
| array | $chained | Задания, которые должны выполняться, если это задание выполнено успешно. | из Queueable |
| mixed | $event | Экземпляр события. | |
| int | $tries | Количество попыток выполнения задания. | |
| int | $timeout | Количество секунд, которые задание может работать, прежде чем истечет время ожидания. | |
| int | $backoff | Количество секунд ожидания перед повторной попыткой выполнения задания при возникновении необработанного исключения. |
Методы
| $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 | 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 | __construct(mixed $event) Создайте новый экземпляр обработчика заданий. | |
| void | handle(Factory $manager) Обработайте задание в очереди. | |
| array | getPayloadFromEvent(mixed $event) Получите payload для данного события. | |
| mixed | formatProperty(mixed $value) Отформатируйте заданное значение для свойства. | |
| string | displayName() Получите отображаемое имя задания в очереди. | |
| void | __clone() Подготовьте экземпляр для клонирования. |
Подробности
$this onConnection(string|null $connection)
Установите желаемое соединение для задания.
$this onQueue(string|null $queue)
Установите желаемую очередь для задания.
$this allOnConnection(string|null $connection)
Установите желаемое соединение для цепочки.
$this allOnQueue(string|null $queue)
Установите желаемую очередь для цепочки.
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)
Установите желаемую задержку в секундах для задачи.
$this afterCommit()
Укажите, что задача должна быть отправлена после подтверждения всех транзакций базы данных.
$this beforeCommit()
Укажите, что задача не должна ждать, пока транзакции базы данных будут подтверждены перед отправкой.
$this through(array|object $middleware)
Укажите, через какой middleware должна быть отправлена задача.
$this chain(array $chain)
Установите задачи, которые должны выполняться, если эта задача выполнена успешно.
$this prependToChain(mixed $job)
Добавить задачу в начало текущей цепочки, чтобы она выполнялась после текущей задачи.
$this appendToChain(mixed $job)
Добавить задачу в конец текущей цепочки.
protected string serializeJob(mixed $job)
Сериализовать задачу для очереди.
void dispatchNextJobInChain()
Отправить следующую задачу в цепочке.
void invokeChainCatchCallbacks(Throwable $e)
Вызвать все обработчики ошибок задачи в цепочке.
void __construct(mixed $event)
Создать новый экземпляр обработчика задач.
void handle(Factory $manager)
Обработать задачу в очереди.
protected array getPayloadFromEvent(mixed $event)
Получить данные для заданного события.
protected mixed formatProperty(mixed $value)
Отформатировать заданное значение для свойства.
string displayName()
Получить отображаемое имя для задачи в очереди.
void __clone()
Подготовить экземпляр для клонирования.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Broadcasting/BroadcastEvent.html
