trait Illuminate / Bus / Batchable
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

Batchable

Properties

public

$batchId string

The batch ID (if applicable).

Default: null
private

$fakeBatch BatchFake

The fake batch, if applicable.

Default: null

Methods

public

batch ( ) : Batch |null

Get the batch instance for the job, if applicable.

public

batching ( ) : bool

Determine if the batch is still active and processing.

public

withBatchId ( string $batchId ) : $this

Set the batch ID on the job.

Parameters

  • $batchId string
public

withFakeBatch ( string $id , string $name , int $totalJobs , int $pendingJobs , int $failedJobs , array $failedJobIds , array $options , Carbon\CarbonImmutable $createdAt , Carbon\CarbonImmutable $cancelledAt , Carbon\CarbonImmutable $finishedAt ) : array{0: $this, 1: \...\BatchFake}

Indicate that the job should use a fake batch.

Parameters

  • $id string
  • $name string
  • $totalJobs int
  • $pendingJobs int
  • $failedJobs int
  • $failedJobIds array
  • $options array
  • $createdAt Carbon\CarbonImmutable
  • $cancelledAt Carbon\CarbonImmutable|null
  • $finishedAt Carbon\CarbonImmutable|null