1. trait
  2. Illuminate
  3. \
  4. Bus
  5. \
  6. Batchable

Batchable

trait Batchable (View source)

Properties

string $batchId

The batch ID (if applicable).

Methods

Batch|null
batch()

Get the batch instance for the job, if applicable.

bool
batching()

Determine if the batch is still active and processing.

$this
withBatchId(string $batchId)

Set the batch ID on the job.

BatchFake}
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable|null $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Indicate that the job should use a fake batch.

Details

at line 31
Batch|null batch()

Get the batch instance for the job, if applicable.

Return Value

Batch|null

at line 47
bool batching()

Determine if the batch is still active and processing.

Return Value

bool

at line 60
$this withBatchId(string $batchId)

Set the batch ID on the job.

Parameters

string $batchId

Return Value

$this

at line 82
BatchFake} withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable|null $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Indicate that the job should use a fake batch.

Parameters

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

Return Value

BatchFake}

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.