ChainedBatch

класс ChainedBatch реализует ShouldQueue (View source)

Свойства

string	$batchId	Идентификатор пакета (применимо).	из Batchable
Job\|null	$job	Экземпляр базовой очереди.	из InteractsWithQueue
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
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.	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение представляет собой интервал, преобразует его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее время системы в формате UNIX timestamp.	из InteractsWithTime
string	runTimeForHumans(float $startTime, float $endTime = null) Выводит общее время выполнения в удобочитаемом для человека формате.	из 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	withFakeQueueInteractions() Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть смоделированы.	из InteractsWithQueue
$this	assertDeleted() Утверждение, что задача была удалена из очереди.	из InteractsWithQueue
$this	assertFailed() Утверждение, что задача была завершена с ошибкой.	из InteractsWithQueue
$this	assertReleased(DateTimeInterface\|DateInterval\|int $delay = null) Утверждение, что задача была возвращена в очередь.	из 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	withoutDelay() Установите задержку для задачи в ноль секунд.	из 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	assertHasChain(array $expectedChain) Утверждение, что задача имеет заданную цепочку задач.	из Queueable
void	assertDoesntHaveChain() Утверждение, что задача не имеет оставшихся задач в цепочке.	из 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

END_OF_DOCUMENT_MARKER

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

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

Параметры

bool\|Closure	$boolean
mixed	...$arguments

Значение возврата

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

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

Очередные задачи будут отправлены в очередь «синхронно».

Параметры

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.

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

DateTimeInterface|int

protected int currentTime()

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

Значение возврата

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

На основе начального времени, отформатировать общее время выполнения для удобного восприятия человеком.

Параметры

float	$startTime
float	$endTime

Значение возврата

string

int attempts()

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

Значение возврата

int

void delete()

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

Значение возврата

void

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

Признаётся провал задачи в очереди.

Параметры

Throwable|string|null

$exception

Значение возврата

void

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

void

$this withFakeQueueInteractions()

Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть смоделированы.

Значение возврата

$this

$this assertDeleted()

Утвердить, что задача была удалена из очереди.

Значение возврата

$this

$this assertFailed()

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

Значение возврата

$this

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Утвердить, что задача была возвращена в очередь.

Параметры

DateTimeInterface|DateInterval|int

$delay

Значение возврата

$this

$this setJob(Job $job)

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

Параметры

Job

$job

Значение возврата

$this

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

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

Параметры

array|object

$middleware

Значение возврата

$this

$this chain(array $chain)

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

Параметры

array

$chain

Значение возврата

$this

$this prependToChain(mixed $job)

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

Параметры

mixed

$job

Значение возврата

$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

Значение возврата

void

void assertHasChain(array $expectedChain)

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

Параметры

array

$expectedChain

Значение возврата

void

void assertDoesntHaveChain()

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

Значение возврата

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/11.x/Illuminate/Bus/ChainedBatch.html