Spec-Zone.ru › Laravel 10

ChainedBatch

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

Свойства

Batchable
Dispatchable
InteractsWithQueue
Queueable
InteractsWithTime

Свойства

string $batchId

Идентификатор пакета (применимо).

 из Batchable
Job|null $job

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

 из InteractsWithQueue
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
Collection $jobs

Коллекция заданий пакета.
string $name

Имя пакета.
array $options

Параметры пакета.

Методы

Пачка|null batch()

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

 из Batchable
bool batching()

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

 из Batchable
$this withBatchId(string $batchId)

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

 из Batchable
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable|null $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Указать, что задача должна использовать фейковую пачку.

 из Batchable
static PendingDispatch dispatch(mixed ...$arguments)

Отправить задачу с заданными аргументами.

 из Dispatchable
static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)

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

 из Dispatchable
static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

Отправить задачу с заданными аргументами, если заданное условие ложно.

 из Dispatchable
static mixed dispatchSync(mixed ...$arguments)

Отправить команду соответствующему обработчику в текущем процессе.

 из Dispatchable
static mixed dispatchAfterResponse(mixed ...$arguments)

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

 из Dispatchable
static PendingChain withChain(array $chain)

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

 из Dispatchable
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

 из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате Unix timestamp.

 из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

 из InteractsWithTime
int currentTime()

Получить текущее системное время в формате Unix timestamp.

 из InteractsWithTime
int attempts()

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

 из InteractsWithQueue
void delete()

Удалить задачу из очереди.

 из InteractsWithQueue
void fail(Throwable|string|null $exception = null)

Отметить задачу как завершенную с ошибкой.

 из InteractsWithQueue
void release(DateTimeInterface|DateInterval|int $delay = 0)

Вернуть задачу обратно в очередь через (n) секунд.

 из InteractsWithQueue
$this setJob(Job $job)

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

 из InteractsWithQueue
$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)

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

 из 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(PendingBatch $batch)

Создать новый экземпляр пакетной цепочки.
static Collection prepareNestedBatches(Collection $jobs)

Подготовить любые вложенные пакеты в заданном наборе задач.
void handle()

Обработать задачу.
PendingBatch toPendingBatch()

Преобразовать экземпляр пакетной цепочки в пакет ожидания.
PendingBatch attachRemainderOfChainToEndOfBatch(PendingBatch $batch)

Переместить оставшуюся часть цепочки в обратный вызов пакета «finally».

Подробности

Batch|null batch()

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

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

Batch|null

bool batching()

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

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

bool

$this withBatchId(string $batchId)

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

Параметры

string $batchId

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

$this

withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable|null $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

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

Параметры

string $id
string $name
int $totalJobs
int $pendingJobs
int $failedJobs
array $failedJobIds
array $options
CarbonImmutable|null $createdAt
CarbonImmutable|null $cancelledAt
CarbonImmutable|null $finishedAt

static PendingDispatch dispatch(mixed ...$arguments)

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

Параметры

mixed ...$arguments

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

PendingDispatch

static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)

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

Параметры

bool|Closure $boolean
mixed ...$arguments

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

PendingDispatch|Fluent

static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

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

Параметры

bool|Closure $boolean
mixed ...$arguments

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

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

Выполнить команду в текущем процессе к соответствующему обработчику.

Задачи Queueable будут выполняться в очереди «sync».

Параметры

mixed ...$arguments

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

mixed

static mixed dispatchAfterResponse(mixed ...$arguments)

Выполнить команду к соответствующему обработчику после текущего процесса.

Параметры

mixed ...$arguments

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

mixed

static PendingChain withChain(array $chain)

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

Параметры

array $chain

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

PendingChain

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить метку времени UNIX для «доступности».

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате метки времени UNIX.

Return Value

int

int attempts()

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

Return Value

int

void delete()

Удалить задание из очереди.

Return Value

void

void fail(Throwable|string|null $exception = null)

Отметить задание как завершенное с ошибкой в очереди.

Parameters

Throwable|string|null $exception

Return Value

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Вернуть задание обратно в очередь через (n) секунд.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

void

$this setJob(Job $job)

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

Parameters

Job $job

Return Value

$this

$this onConnection(string|null $connection)

Указать желаемое соединение для задания.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

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

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

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

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

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

Parameters

string|null $queue

Return Value

$this

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

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

Parameters

DateTimeInterface|DateInterval|array|int|null $delay

Return Value

$this

$this afterCommit()

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

Return Value

$this

$this beforeCommit()

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

Return Value

$this

$this through(array|object $middleware)

Указать, через какой 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)

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

Параметры

mixed $job

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

$this

protected string serializeJob(mixed $job)

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

Параметры

mixed $job

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

string

Исключения

RuntimeException

void dispatchNextJobInChain()

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

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

void

void invokeChainCatchCallbacks(Throwable $e)

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

Параметры

Throwable $e

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

void

void __construct(PendingBatch $batch)

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

Параметры

PendingBatch $batch

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

void

static Collection prepareNestedBatches(Collection $jobs)

Подготовить любые вложенные партии в данном наборе задач.

Параметры

Collection $jobs

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

Collection

void handle()

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

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

void

PendingBatch toPendingBatch()

Преобразовать экземпляр цепочечной партии в партию ожидания.

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

PendingBatch

protected PendingBatch attachRemainderOfChainToEndOfBatch(PendingBatch $batch)

Переместить оставшуюся часть цепочки в обработчик партии "finally".

Параметры

PendingBatch $batch

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

PendingBatch

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

Spec-Zone.ru

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