Пачка
класс Пачка реализует 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|array $jobs)
Добавить дополнительные задачи в пачку. | |
| Коллекция | 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()
Определить, есть ли у пачки обратные вызовы «наконец». | |
| void | cancel()
Отменить пачку. | |
| bool | canceled()
Определить, была ли отменена пачка. | |
| bool | cancelled()
Определить, была ли отменена пачка. | |
| void | delete()
Удалить пачку из хранилища. | |
| void | invokeHandlerCallback(callable $handler, Batch $batch, Throwable $e = null)
Вызвать обработчик обратного вызова пачки. | |
| array | 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|array $jobs)
Добавить дополнительные задачи в пакет.
protected 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()
Определить, содержит ли пакет обратные вызовы "catch".
bool hasFinallyCallbacks()
Определить, содержит ли пакет обратные вызовы "finally".
void cancel()
Отменить пакет.
bool canceled()
Определить, был ли пакет отменён.
bool cancelled()
Определить, был ли пакет отменён.
void delete()
Удалить пакет из хранилища.
protected void invokeHandlerCallback(callable $handler, Batch $batch, Throwable $e = null)
Вызвать обработчик обратного вызова пакета.
array 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/8.x/Illuminate/Bus/Batch.html
