BatchFake
class BatchFake extends Batch (View source)
Свойства
| protected Factory | $queue | Реализация фабрики очереди. | из Batch |
| protected BatchRepository | $repository | Реализация репозитория. | из Batch |
| string | $id | Идентификатор пакета. | из Batch |
| string | $name | Имя пакета. | из Batch |
| int | $totalJobs | Общее количество задач, относящихся к пакету. | из Batch |
| int | $pendingJobs | Общее количество задач, которые всё ещё ожидают выполнения. | из Batch |
| int | $failedJobs | Общее количество задач, которые завершились неудачно. | из Batch |
| array | $failedJobIds | Идентификаторы задач, завершившихся неудачно. | из Batch |
| array | $options | Параметры пакета. | из Batch |
| CarbonImmutable | $createdAt | Дата создания пакета. | из Batch |
| CarbonImmutable|null | $cancelledAt | Дата отмены пакета. | из Batch |
| CarbonImmutable|null | $finishedAt | Дата завершения пакета. | из 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(Перечисляемый|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 $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(Перечисляемый|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()
Определить, содержит ли пакет обратные вызовы "progress".
bool hasThenCallbacks()
Определить, содержит ли пакет обратные вызовы "success".
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)
Динамический доступ к "параметрам" пакета через свойства.
bool deleted()
Определить, был ли пакет удалён.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Testing/Fakes/BatchFake.html
