Пачка

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

Свойства

protected Factory	$queue	Реализация фабрики очереди.
protected BatchRepository	$repository	Реализация репозитория.
string	$id	Идентификатор пачки.
string	$name	Название пачки.
int	$totalJobs	Общее количество задач, относящихся к пачке.
int	$pendingJobs	Общее количество задач, которые еще ожидаются.
int	$failedJobs	Общее количество задач, которые завершились ошибкой.
array	$failedJobIds	Идентификаторы задач, которые завершились ошибкой.
array	$options	Параметры пачки.
CarbonImmutable	$createdAt	Дата создания пачки.
CarbonImmutable\|null	$cancelledAt	Дата отмены пачки.
CarbonImmutable\|null	$finishedAt	Дата завершения пачки.

Методы

void

__construct(Factory $queue, BatchRepository $repository, string $id, string $name, int $totalJobs, int $pendingJobs, int $failedJobs, array $failedJobIds, array $options, CarbonImmutable $createdAt, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Создать новую пачку.

Batch

fresh()

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

Batch

add(Enumerable|object|array $jobs)

Добавить дополнительные задачи в пачку.

Collection

prepareBatchedChain(array $chain)

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

int

processedJobs()

Получить общее количество обработанных задач в пачке.

int

progress()

Получить процент обработанных задач (от 0 до 100).

void

recordSuccessfulJob(string $jobId)

Зарегистрировать успешное выполнение задачи в пачке, выполнив необходимые обратные вызовы.

UpdatedBatchJobCounts

decrementPendingJobs(string $jobId)

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

bool

finished()

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

bool

hasThenCallbacks()

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

bool

allowsFailures()

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

bool

hasFailures()

Определить, есть ли ошибки задач в пачке.

void

recordFailedJob(string $jobId, Throwable $e)

Зарегистрировать, что задача в пачке не завершилась успешно, выполнив необходимые обратные вызовы.

UpdatedBatchJobCounts

incrementFailedJobs(string $jobId)

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

bool

hasCatchCallbacks()

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

bool

hasFinallyCallbacks()

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

void

cancel()

Отменить пачку.

bool

canceled()

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

bool

cancelled()

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

void

delete()

Удалить пачку из хранилища.

void

invokeHandlerCallback(callable $handler, Batch $batch, Throwable $e = null)

Вызвать обработчик обратного вызова пачки.

toArray()

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

array

jsonSerialize()

Получить JSON-сериализуемое представление объекта.

mixed

__get(string $key)

Динамический доступ к "параметрам" пачки через свойства.

Подробности

void __construct(Factory $queue, BatchRepository $repository, string $id, string $name, int $totalJobs, int $pendingJobs, int $failedJobs, array $failedJobIds, array $options, CarbonImmutable $createdAt, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Создать новую пачку.

Параметры

Factory	$queue
BatchRepository	$repository
string	$id
string	$name
int	$totalJobs
int	$pendingJobs
int	$failedJobs
array	$failedJobIds
array	$options
CarbonImmutable	$createdAt
CarbonImmutable\|null	$cancelledAt
CarbonImmutable\|null	$finishedAt

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

void

Batch fresh()

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

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

Batch

END_OF_DOCUMENT_MARKER

Batch add(Enumerable|object|array $jobs)

Добавить дополнительные задачи в пакет.

Параметры

Enumerable|object|array

$jobs

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

Batch

protected Collection prepareBatchedChain(array $chain)

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

Параметры

array

$chain

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

Collection

int processedJobs()

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

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

int

int progress()

Получить процент обработанных задач (от 0 до 100).

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

int

void recordSuccessfulJob(string $jobId)

Зафиксировать успешное завершение задачи в пакете, выполняя необходимые обратные вызовы при необходимости.

Параметры

string

$jobId

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

void

UpdatedBatchJobCounts decrementPendingJobs(string $jobId)

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

Параметры

string

$jobId

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

UpdatedBatchJobCounts

bool finished()

Определить, завершил ли пакет выполнение.

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

bool

bool hasThenCallbacks()

Определить, содержит ли пакет обратные вызовы "успеха".

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

bool

bool allowsFailures()

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

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

bool

bool hasFailures()

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

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

bool

void recordFailedJob(string $jobId, Throwable $e)

Зафиксировать неудачу завершения задачи в пакете, выполняя необходимые обратные вызовы при необходимости.

Параметры

string	$jobId
Throwable	$e

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

void

UpdatedBatchJobCounts incrementFailedJobs(string $jobId)

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

Параметры

string

$jobId

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

UpdatedBatchJobCounts

bool hasCatchCallbacks()

Определить, содержит ли пакет обратные вызовы "перехвата".

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

bool

bool hasFinallyCallbacks()

Определить, содержит ли пакет обратные вызовы "finally".

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

bool

void cancel()

Отменить пакет.

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

void

bool canceled()

Определить, был ли пакет отменён.

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

bool

bool cancelled()

Определить, был ли пакет отменён.

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

bool

void delete()

Удалить пакет из хранилища.

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

void

protected void invokeHandlerCallback(callable $handler, Batch $batch, Throwable $e = null)

Вызвать обработчик обратного вызова пакета.

Параметры

callable	$handler
Batch	$batch
Throwable	$e

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

void

toArray()

Преобразовать пакет в массив.

array jsonSerialize()

Получить JSON-сериализуемое представление объекта.

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

array

mixed __get(string $key)

Динамический доступ к «параметрам» пакета через свойства.

Параметры

string

$key

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

mixed

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