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 | 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(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 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)
Динамический доступ к "параметрам" группы через свойства.
bool deleted()
Определить, была ли группа удалена.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Support/Testing/Fakes/BatchFake.html
