W3cubDocs

/Laravel 8

PendingBatch

class PendingBatch (View source)

Properties

protected Container $container The IoC container instance.
string $name The batch name.
Collection $jobs The jobs that belong to the batch.
array $options The batch options.

Methods

void __construct(Container $container, Collection $jobs)

Create a new pending batch instance.
$this then(callable $callback)

Add a callback to be executed after all jobs in the batch have executed successfully.
array thenCallbacks()

Get the "then" callbacks that have been registered with the pending batch.
$this catch(callable $callback)

Add a callback to be executed after the first failing job in the batch.
array catchCallbacks()

Get the "catch" callbacks that have been registered with the pending batch.
$this finally(callable $callback)

Add a callback to be executed after the batch has finished executing.
array finallyCallbacks()

Get the "finally" callbacks that have been registered with the pending batch.
$this allowFailures(bool $allowFailures = true)

Indicate that the batch should not be cancelled when a job within the batch fails.
bool allowsFailures()

Determine if the pending batch allows jobs to fail without cancelling the batch.
$this name(string $name)

Set the name for the batch.
$this onConnection(string $connection)

Specify the queue connection that the batched jobs should run on.
string|null connection()

Get the connection used by the pending batch.
$this onQueue(string $queue)

Specify the queue that the batched jobs should run on.
string|null queue()

Get the queue used by the pending batch.
Batch dispatch()

Dispatch the batch.

Details

void __construct(Container $container, Collection $jobs)

Create a new pending batch instance.

Parameters

Container $container
Collection $jobs

Return Value

void

$this then(callable $callback)

Add a callback to be executed after all jobs in the batch have executed successfully.

Parameters

callable $callback

Return Value

$this

array thenCallbacks()

Get the "then" callbacks that have been registered with the pending batch.

Return Value

array

$this catch(callable $callback)

Add a callback to be executed after the first failing job in the batch.

Parameters

callable $callback

Return Value

$this

array catchCallbacks()

Get the "catch" callbacks that have been registered with the pending batch.

Return Value

array

$this finally(callable $callback)

Add a callback to be executed after the batch has finished executing.

Parameters

callable $callback

Return Value

$this

array finallyCallbacks()

Get the "finally" callbacks that have been registered with the pending batch.

Return Value

array

$this allowFailures(bool $allowFailures = true)

Indicate that the batch should not be cancelled when a job within the batch fails.

Parameters

bool $allowFailures

Return Value

$this

bool allowsFailures()

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

Return Value

bool

$this name(string $name)

Set the name for the batch.

Parameters

string $name

Return Value

$this

$this onConnection(string $connection)

Specify the queue connection that the batched jobs should run on.

Parameters

string $connection

Return Value

$this

string|null connection()

Get the connection used by the pending batch.

Return Value

string|null

$this onQueue(string $queue)

Specify the queue that the batched jobs should run on.

Parameters

string $queue

Return Value

$this

string|null queue()

Get the queue used by the pending batch.

Return Value

string|null

Batch dispatch()

Dispatch the batch.

Return Value

Batch

Exceptions

Throwable

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