1. class
  2. Hypervel
  3. \
  4. Bus
  5. \
  6. Batch

Batch

class Batch implements Arrayable, JsonSerializable

Methods

__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|null
fresh()

Get a fresh instance of the batch represented by this ID.

Batch|null
add(array|object $jobs)

Add additional jobs to the batch.

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|null
decrementPendingJobs(string $jobId)

Decrement the pending jobs for the batch.

void
invokeCallbacks(string $type, Throwable|null $e = null)

Invoke the callbacks of the given type.

bool
finished()

Determine if the batch has finished executing.

bool
hasProgressCallbacks()

Determine if the batch has "progress" callbacks.

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|null $e)

Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.

UpdatedBatchJobCounts|null
incrementFailedJobs(string $jobId)

Increment the failed jobs for the batch.

bool
isFirstJobProcessed(UpdatedBatchJobCounts $counts)

Determine if this is the first job processed in the batch.

bool
hasCatchCallbacks()

Determine if the batch has "catch" callbacks.

bool
hasFailureCallbacks()

Determine if the batch has "failure" callbacks.

bool
hasFinallyCallbacks()

Determine if the batch has "finally" callbacks.

void
cancel(Throwable|null $exception = null)

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.

void
invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $e = null)

Invoke a batch callback handler.

array
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.

Details

at line 28
__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.

Parameters

Factory $queue
BatchRepository $repository
string $id
string $name
int $totalJobs
int $pendingJobs
int $failedJobs
array $failedJobIds
array $options
CarbonImmutable $createdAt
CarbonImmutable|null $cancelledAt
CarbonImmutable|null $finishedAt

at line 47
Batch|null fresh()

Get a fresh instance of the batch represented by this ID.

Return Value

Batch|null

at line 57
Batch|null add(array|object $jobs)

Add additional jobs to the batch.

Parameters

array|object $jobs

Return Value

Batch|null

at line 104
protected Collection prepareBatchedChain(array $chain)

Prepare a chain that exists within the jobs being added.

Parameters

array $chain

Return Value

Collection

at line 116
int processedJobs()

Get the total number of jobs that have been processed by the batch thus far.

Return Value

int

at line 126
int progress()

Get the percentage of jobs that have been processed (between 0-100).

Return Value

int

at line 134
void recordSuccessfulJob(string $jobId)

Record that a job within the batch finished successfully, executing any callbacks if necessary.

Parameters

string $jobId

Return Value

void

at line 184
UpdatedBatchJobCounts|null decrementPendingJobs(string $jobId)

Decrement the pending jobs for the batch.

Parameters

string $jobId

Return Value

UpdatedBatchJobCounts|null

at line 192
protected void invokeCallbacks(string $type, Throwable|null $e = null)

Invoke the callbacks of the given type.

Parameters

string $type
Throwable|null $e

Return Value

void

at line 208
bool finished()

Determine if the batch has finished executing.

Return Value

bool

at line 216
bool hasProgressCallbacks()

Determine if the batch has "progress" callbacks.

Return Value

bool

at line 224
bool hasThenCallbacks()

Determine if the batch has "success" callbacks.

Return Value

bool

at line 232
bool allowsFailures()

Determine if the batch allows jobs to fail without cancelling the batch.

Return Value

bool

at line 240
bool hasFailures()

Determine if the batch has job failures.

Return Value

bool

at line 248
void recordFailedJob(string $jobId, Throwable|null $e)

Record that a job within the batch failed to finish successfully, executing any callbacks if necessary.

Parameters

string $jobId
Throwable|null $e

Return Value

void

at line 294
UpdatedBatchJobCounts|null incrementFailedJobs(string $jobId)

Increment the failed jobs for the batch.

Parameters

string $jobId

Return Value

UpdatedBatchJobCounts|null

at line 302
protected bool isFirstJobProcessed(UpdatedBatchJobCounts $counts)

Determine if this is the first job processed in the batch.

Parameters

UpdatedBatchJobCounts $counts

Return Value

bool

at line 310
bool hasCatchCallbacks()

Determine if the batch has "catch" callbacks.

Return Value

bool

at line 318
bool hasFailureCallbacks()

Determine if the batch has "failure" callbacks.

Return Value

bool

at line 326
bool hasFinallyCallbacks()

Determine if the batch has "finally" callbacks.

Return Value

bool

at line 334
void cancel(Throwable|null $exception = null)

Cancel the batch.

Parameters

Throwable|null $exception

Return Value

void

at line 352
bool canceled()

Determine if the batch has been cancelled.

Return Value

bool

at line 360
bool cancelled()

Determine if the batch has been cancelled.

Return Value

bool

at line 368
void delete()

Delete the batch from storage.

Return Value

void

at line 376
protected void invokeHandlerCallback(callable $handler, Batch $batch, Throwable|null $e = null)

Invoke a batch callback handler.

Parameters

callable $handler
Batch $batch
Throwable|null $e

Return Value

void

at line 390
array toArray()

Convert the batch to an array.

Return Value

array

at line 410
array jsonSerialize()

Get the JSON serializable representation of the object.

Return Value

array

at line 418
mixed __get(string $key)

Dynamically access the batch's "options" via properties.

Parameters

string $key

Return Value

mixed