BatchFake
class BatchFake extends Batch
Properties
| array | $added | The jobs that have been added to the batch. |
|
| bool | $deleted | Indicates if the batch has been deleted. |
Methods
Create a new batch instance.
Prepare a chain that exists within the jobs being added.
Get the total number of jobs that have been processed by the batch thus far.
Record that a job within the batch finished successfully, executing any callbacks if necessary.
Decrement the pending jobs for the batch.
Determine if the batch allows jobs to fail without cancelling the batch.
Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.
Increment the failed jobs for the batch.
Determine if this is the first job processed in the batch.
Delete the batch from storage.
Invoke a batch callback handler.
Determine if the batch has been deleted.
Details
at line 29
__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)
Create a new batch instance.
at line 46
Batch|null
fresh()
Get a fresh instance of the batch represented by this ID.
at line 56
Batch|null
add(array|object $jobs)
Add additional jobs to the batch.
in
Batch at line 104
protected Collection
prepareBatchedChain(array $chain)
Prepare a chain that exists within the jobs being added.
in
Batch at line 116
int
processedJobs()
Get the total number of jobs that have been processed by the batch thus far.
in
Batch at line 126
int
progress()
Get the percentage of jobs that have been processed (between 0-100).
at line 72
void
recordSuccessfulJob(string $jobId)
Record that a job within the batch finished successfully, executing any callbacks if necessary.
at line 79
UpdatedBatchJobCounts|null
decrementPendingJobs(string $jobId)
Decrement the pending jobs for the batch.
in
Batch at line 192
protected void
invokeCallbacks(string $type, Throwable|null $e = null)
Invoke the callbacks of the given type.
in
Batch at line 208
bool
finished()
Determine if the batch has finished executing.
in
Batch at line 216
bool
hasProgressCallbacks()
Determine if the batch has "progress" callbacks.
in
Batch at line 224
bool
hasThenCallbacks()
Determine if the batch has "success" callbacks.
in
Batch at line 232
bool
allowsFailures()
Determine if the batch allows jobs to fail without cancelling the batch.
in
Batch at line 240
bool
hasFailures()
Determine if the batch has job failures.
at line 87
void
recordFailedJob(string $jobId, Throwable|null $e)
Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.
at line 94
UpdatedBatchJobCounts|null
incrementFailedJobs(string $jobId)
Increment the failed jobs for the batch.
in
Batch at line 302
protected bool
isFirstJobProcessed(UpdatedBatchJobCounts $counts)
Determine if this is the first job processed in the batch.
in
Batch at line 310
bool
hasCatchCallbacks()
Determine if the batch has "catch" callbacks.
in
Batch at line 318
bool
hasFailureCallbacks()
Determine if the batch has "failure" callbacks.
in
Batch at line 326
bool
hasFinallyCallbacks()
Determine if the batch has "finally" callbacks.
at line 102
void
cancel(Throwable|null $exception = null)
Cancel the batch.
in
Batch at line 352
bool
canceled()
Determine if the batch has been cancelled.
in
Batch at line 360
bool
cancelled()
Determine if the batch has been cancelled.
at line 110
void
delete()
Delete the batch from storage.
in
Batch at line 376
protected void
invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $e = null)
Invoke a batch callback handler.
in
Batch at line 390
array
toArray()
Convert the batch to an array.
in
Batch at line 410
array
jsonSerialize()
Get the JSON serializable representation of the object.
in
Batch at line 418
mixed
__get(string $key)
Dynamically access the batch's "options" via properties.
at line 118
bool
deleted()
Determine if the batch has been deleted.