Пачка
класс Пачка реализует 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)
Создать новую пачку. | |
| Пачка | fresh()
Получить свежий экземпляр пачки по этому идентификатору. | |
| Пачка | add(Enumerable|object|array $jobs)
Добавить дополнительные задачи в пачку. | |
| Коллекция | 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()
Определить, есть ли у пачки обратные вызовы «finally». | |
| void | cancel()
Отменить пачку. | |
| bool | canceled()
Определить, была ли пачка отменена. | |
| bool | cancelled()
Определить, была ли пачка отменена. | |
| void | delete()
Удалить пачку из хранилища. | |
| void | invokeHandlerCallback(callable $handler, Пачка $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)
Создать новую пачку.
Пачка 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 $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/10.x/Illuminate/Bus/Batch.html
