Пачка
класс Пачка реализует 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 | hasProgressCallbacks()
Определить, есть ли в пачке коллбеки "прогресса". | |
| bool | hasThenCallbacks()
Определить, есть ли в пачке коллбеки "успеха". | |
| bool | allowsFailures()
Определить, разрешает ли пачка задачи завершаться ошибкой, не отменяя пачку. | |
| bool | hasFailures()
Определить, есть ли ошибки в задачах пачки. | |
| void | recordFailedJob(string $jobId, Throwable $e)
Записать, что задача в пачке завершилась ошибкой, выполнив необходимые обратные вызовы, если они есть. | |
| UpdatedBatchJobCounts | incrementFailedJobs(string $jobId)
Увеличить счетчик завершившихся с ошибкой задач для пачки. | |
| bool | hasCatchCallbacks()
Определить, есть ли в пачке коллбеки "исключений". | |
| bool | hasFinallyCallbacks()
Определить, есть ли в пачке коллбеки "наконец". | |
| void | cancel()
Отменить пачку. | |
| bool | canceled()
Определить, была ли отменена пачка. | |
| bool | cancelled()
Определить, была ли отменена пачка. | |
| void | delete()
Удалить пачку из хранилища. | |
| void | invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $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)
Создать новый экземпляр пачки.
Batch fresh()
Получить новый экземпляр пачки по ее идентификатору.
Batch add(Enumerable|object|array $jobs)
Добавить дополнительные задачи в пакет.
protected Collection prepareBatchedChain(array $chain)
Подготовить цепочку, которая существует в задачах, добавляемых в пакет.
int processedJobs()
Получить общее количество задач, обработанных пакетом до настоящего момента.
int progress()
Получить процент задач, обработанных (от 0 до 100).
void recordSuccessfulJob(string $jobId)
Зафиксировать, что задача в пакете завершилась успешно, выполнив необходимые обратные вызовы при необходимости.
UpdatedBatchJobCounts decrementPendingJobs(string $jobId)
Уменьшить количество ожидающих задач для пакета.
bool finished()
Определить, завершил ли пакет выполнение.
bool hasProgressCallbacks()
Определить, есть ли у пакета обратные вызовы "прогресса".
bool hasThenCallbacks()
Определить, есть ли у пакета обратные вызовы "успеха".
bool allowsFailures()
Определить, разрешает ли пакет задачам завершаться с ошибками, не отменяя пакет.
bool hasFailures()
Определить, есть ли в пакете сбои задач.
void recordFailedJob(string $jobId, Throwable $e)
Зафиксировать, что задача в пакете не смогла завершиться успешно, выполнив необходимые обратные вызовы при необходимости.
UpdatedBatchJobCounts incrementFailedJobs(string $jobId)
Увеличить количество задач, завершившихся неудачно, для пакета.
bool hasCatchCallbacks()
Определить, есть ли у пакета обратные вызовы "catch".
bool hasFinallyCallbacks()
Определить, есть ли у пакета обратные вызовы "finally".
void cancel()
Отменить пакет.
bool canceled()
Определить, был ли пакет отменён.
bool cancelled()
Определить, был ли пакет отменён.
void delete()
Удалить пакет из хранилища.
protected void invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $e = null)
Вызвать обработчик обратного вызова пакета.
toArray()
Преобразовать пакет в массив.
array jsonSerialize()
Получить представление объекта, сериализуемого в JSON.
mixed __get(string $key)
Динамический доступ к "параметрам" пакета через свойства.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Bus/Batch.html
