BatchFake
class BatchFake extends Batch (View source)
Свойства
| protected Factory | $queue | Реализация фабрики очереди. | from Batch |
| protected BatchRepository | $repository | Реализация репозитория. | from Batch |
| string | $id | Идентификатор пакета. | from Batch |
| string | $name | Имя пакета. | from Batch |
| int | $totalJobs | Общее количество задач, принадлежащих пакету. | from Batch |
| int | $pendingJobs | Общее количество задач, которые все еще ожидают выполнения. | from Batch |
| int | $failedJobs | Общее количество задач, которые завершились ошибкой. | from Batch |
| array | $failedJobIds | Идентификаторы задач, которые завершились ошибкой. | from Batch |
| array | $options | Параметры пакета. | from Batch |
| CarbonImmutable | $createdAt | Дата создания пакета. | from Batch |
| CarbonImmutable|null | $cancelledAt | Дата отмены пакета. | from Batch |
| CarbonImmutable|null | $finishedAt | Дата завершения пакета. | from Batch |
| array | $added | Задачи, добавленные в пакет. | |
| bool | $deleted | Указывает, был ли пакет удален. |
Методы
| void | __construct(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()
Определить, есть ли у пакета обратные вызовы "catch". | из пакета |
| bool | hasFinallyCallbacks()
Определить, есть ли у пакета обратные вызовы "finally". | из пакета |
| void | cancel()
Отменить пакет. | |
| bool | canceled()
Определить, был ли пакет отменён. | из пакета |
| bool | cancelled()
Определить, был ли пакет отменён. | из пакета |
| void | delete()
Удалить пакет из хранилища. | |
| void | invokeHandlerCallback(callable $handler, Пакет $batch, Throwable|null $e = null)
Вызвать обработчик обратного вызова пакета. | из пакета |
| toArray()
Преобразовать пакет в массив. | из пакета | |
| array | jsonSerialize()
Получить JSON-сериализуемое представление объекта. | из пакета |
| mixed | __get(string $key)
Динамический доступ к "параметрам" пакета через свойства. | из пакета |
| bool | deleted()
Определить, был ли пакет удалён. |
Подробности
void __construct(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)
Добавить дополнительные задачи в пакет.
protected Коллекция 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)
Динамический доступ к "параметрам" пакета через свойства.
bool deleted()
Определить, был ли пакет удалён.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Testing/Fakes/BatchFake.html
