Batch
class Batch implements Arrayable, JsonSerializable (View source)
Properties
| protected Factory | $queue | The queue factory implementation. |
|
| protected BatchRepository | $repository | The repository implementation. |
|
| string | $id | The batch ID. |
|
| string | $name | The batch name. |
|
| int | $totalJobs | The total number of jobs that belong to the batch. |
|
| int | $pendingJobs | The total number of jobs that are still pending. |
|
| int | $failedJobs | The total number of jobs that have failed. |
|
| array | $failedJobIds | The IDs of the jobs that have failed. |
|
| array | $options | The batch options. |
|
| CarbonImmutable | $createdAt | The date indicating when the batch was created. |
|
| CarbonImmutable|null | $cancelledAt | The date indicating when the batch was cancelled. |
|
| CarbonImmutable|null | $finishedAt | The date indicating when the batch was finished. |
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.
Get the percentage of jobs that have been processed (between 0-100).
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 has finished executing.
Determine if the batch has "success" callbacks.
Determine if the batch allows jobs to fail without cancelling the batch.
Determine if the batch has job failures.
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 the batch has "catch" callbacks.
Determine if the batch has "finally" callbacks.
Cancel the batch.
Determine if the batch has been cancelled.
Determine if the batch has been cancelled.
Delete the batch from storage.
Invoke a batch callback handler.
Convert the batch to an array.
Get the JSON serializable representation of the object.
Dynamically access the batch's "options" via properties.
Details
void
__construct(Factory $queue, BatchRepository $repository, 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.
protected Collection
prepareBatchedChain(array $chain)
Prepare a chain that exists within the jobs being added.
int
processedJobs()
Get the total number of jobs that have been processed by the batch thus far.
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.
bool
finished()
Determine if the batch has finished executing.
bool
hasThenCallbacks()
Determine if the batch has "success" callbacks.
bool
allowsFailures()
Determine if the batch allows jobs to fail without cancelling the batch.
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.
bool
hasCatchCallbacks()
Determine if the batch has "catch" callbacks.
bool
hasFinallyCallbacks()
Determine if the batch has "finally" callbacks.
void
cancel()
Cancel the batch.
bool
canceled()
Determine if the batch has been cancelled.
bool
cancelled()
Determine if the batch has been cancelled.
void
delete()
Delete the batch from storage.
protected void
invokeHandlerCallback(callable $handler, Batch $batch, Throwable $e = null)
Invoke a batch callback handler.
toArray()
Convert the batch to an array.
array
jsonSerialize()
Get the JSON serializable representation of the object.
mixed
__get(string $key)
Dynamically access the batch's "options" via properties.