BatchFake
class BatchFake extends Batch (View source)
Properties
| protected Factory | $queue | The queue factory implementation. |
from Batch |
| protected BatchRepository | $repository | The repository implementation. |
from Batch |
| string | $id | The batch ID. |
from Batch |
| string | $name | The batch name. |
from Batch |
| int | $totalJobs | The total number of jobs that belong to the batch. |
from Batch |
| int | $pendingJobs | The total number of jobs that are still pending. |
from Batch |
| int | $failedJobs | The total number of jobs that have failed. |
from Batch |
| array | $failedJobIds | The IDs of the jobs that have failed. |
from Batch |
| array | $options | The batch options. |
from Batch |
| CarbonImmutable | $createdAt | The date indicating when the batch was created. |
from Batch |
| CarbonImmutable|null | $cancelledAt | The date indicating when the batch was cancelled. |
from Batch |
| CarbonImmutable|null | $finishedAt | The date indicating when the batch was finished. |
from Batch |
| 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.
Cancel the batch.
Delete the batch from storage.
Invoke a batch callback handler.
Determine if the batch has been deleted.
Details
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)
Create a new batch instance.
Batch
fresh()
Get a fresh instance of the batch represented by this ID.
Batch
add(Enumerable|object|array $jobs)
Add additional jobs to the batch.
in
Batch at line 205
protected Collection
prepareBatchedChain(array $chain)
Prepare a chain that exists within the jobs being added.
in
Batch at line 219
int
processedJobs()
Get the total number of jobs that have been processed by the batch thus far.
in
Batch at line 229
int
progress()
Get the percentage of jobs that have been processed (between 0-100).
void
recordSuccessfulJob(string $jobId)
Record that a job within the batch finished successfully, executing any callbacks if necessary.
UpdatedBatchJobCounts
decrementPendingJobs(string $jobId)
Decrement the pending jobs for the batch.
in
Batch at line 289
bool
finished()
Determine if the batch has finished executing.
in
Batch at line 299
bool
hasProgressCallbacks()
Determine if the batch has "progress" callbacks.
in
Batch at line 309
bool
hasThenCallbacks()
Determine if the batch has "success" callbacks.
in
Batch at line 319
bool
allowsFailures()
Determine if the batch allows jobs to fail without cancelling the batch.
in
Batch at line 329
bool
hasFailures()
Determine if the batch has job failures.
void
recordFailedJob(string $jobId, Throwable $e)
Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.
UpdatedBatchJobCounts
incrementFailedJobs(string $jobId)
Increment the failed jobs for the batch.
in
Batch at line 390
bool
hasCatchCallbacks()
Determine if the batch has "catch" callbacks.
in
Batch at line 400
bool
hasFinallyCallbacks()
Determine if the batch has "finally" callbacks.
void
cancel()
Cancel the batch.
in
Batch at line 420
bool
canceled()
Determine if the batch has been cancelled.
in
Batch at line 430
bool
cancelled()
Determine if the batch has been cancelled.
void
delete()
Delete the batch from storage.
in
Batch at line 453
protected void
invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $e = null)
Invoke a batch callback handler.
in
Batch at line 469
toArray()
Convert the batch to an array.
in
Batch at line 491
array
jsonSerialize()
Get the JSON serializable representation of the object.
in
Batch at line 502
mixed
__get(string $key)
Dynamically access the batch's "options" via properties.
bool
deleted()
Determine if the batch has been deleted.