Docs4dev
Docs
laravel / 10 / api / 10.x / illuminate / bus / batchable.html

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.
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Indicate that the job should use a fake batch.

Details

Batch|null batch()

Get the batch instance for the job, if applicable.

Return Value

Batch|null

bool batching()

Determine if the batch is still active and processing.

Return Value

bool

$this withBatchId(string $batchId)

Set the batch ID on the job.

Parameters

string $batchId

Return Value

$this

withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable $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 $createdAt
CarbonImmutable|null $cancelledAt
CarbonImmutable|null $finishedAt

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Bus/Batchable.html