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
__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.
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.
in
Batch at line 319
bool
allowsFailures()
Determine if the batch allows jobs to fail without cancelling the batch.
void
recordFailedJob(string $jobId, Throwable $e)
Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.
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 502
mixed
__get(string $key)
Dynamically access the batch's "options" via properties.