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.

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

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