ChainedBatch

class ChainedBatch implements ShouldQueue (View source)

Traits

Properties

string	$batchId	The batch ID (if applicable).	from Batchable
Job\|null	$job	The underlying queue job instance.	from InteractsWithQueue
string\|null	$connection	The name of the connection the job should be sent to.	from Queueable
string\|null	$queue	The name of the queue the job should be sent to.	from Queueable
string\|null	$chainConnection	The name of the connection the chain should be sent to.	from Queueable
string\|null	$chainQueue	The name of the queue the chain should be sent to.	from Queueable
array\|null	$chainCatchCallbacks	The callbacks to be executed on chain failure.	from Queueable
DateTimeInterface\|DateInterval\|array\|int\|null	$delay	The number of seconds before the job should be made available.	from Queueable
bool\|null	$afterCommit	Indicates whether the job should be dispatched after all database transactions have committed.	from Queueable
array	$middleware	The middleware the job should be dispatched through.	from Queueable
array	$chained	The jobs that should run if this job is successful.	from Queueable
Collection	$jobs	The collection of batched jobs.
string	$name	The name of the batch.
array	$options	The batch options.

Methods

Batch|null

batch()

Get the batch instance for the job, if applicable.

from Batchable

bool

batching()

Determine if the batch is still active and processing.

from Batchable

$this

withBatchId(string $batchId)

Set the batch ID on the job.

from Batchable

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.

from Batchable

static PendingDispatch

dispatch(mixed ...$arguments)

Dispatch the job with the given arguments.

from Dispatchable

static PendingDispatch|Fluent

dispatchIf(bool|Closure $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

from Dispatchable

static PendingDispatch|Fluent

dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

from Dispatchable

static mixed

dispatchSync(mixed ...$arguments)

Dispatch a command to its appropriate handler in the current process.

from Dispatchable

static mixed

dispatchAfterResponse(mixed ...$arguments)

Dispatch a command to its appropriate handler after the current process.

from Dispatchable

static PendingChain

withChain(array $chain)

Set the jobs that should run if this job is successful.

from Dispatchable

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from InteractsWithTime

int

currentTime()

Get the current system time as a UNIX timestamp.

from InteractsWithTime

int

attempts()

Get the number of times the job has been attempted.

from InteractsWithQueue

void

delete()

Delete the job from the queue.

from InteractsWithQueue

void

fail(Throwable|string|null $exception = null)

Fail the job from the queue.

from InteractsWithQueue

void

release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

from InteractsWithQueue

$this

setJob(Job $job)

Set the base queue job instance.

from InteractsWithQueue

$this

onConnection(string|null $connection)

Set the desired connection for the job.

from Queueable

$this

onQueue(string|null $queue)

Set the desired queue for the job.

from Queueable

$this

allOnConnection(string|null $connection)

Set the desired connection for the chain.

from Queueable

$this

allOnQueue(string|null $queue)

Set the desired queue for the chain.

from Queueable

$this

delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

from Queueable

$this

afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

from Queueable

$this

beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

from Queueable

$this

through(array|object $middleware)

Specify the middleware the job should be dispatched through.

from Queueable

$this

chain(array $chain)

Set the jobs that should run if this job is successful.

from Queueable

$this

prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

from Queueable

$this

appendToChain(mixed $job)

Append a job to the end of the current chain.

from Queueable

string

serializeJob(mixed $job)

Serialize a job for queuing.

from Queueable

void

dispatchNextJobInChain()

Dispatch the next job on the chain.

from Queueable

void

invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

from Queueable

void

__construct(PendingBatch $batch)

Create a new chained batch instance.

static Collection

prepareNestedBatches(Collection $jobs)

Prepare any nested batches within the given collection of jobs.

void

handle()

Handle the job.

PendingBatch

toPendingBatch()

Convert the chained batch instance into a pending batch.

PendingBatch

attachRemainderOfChainToEndOfBatch(PendingBatch $batch)

Move the remainder of the chain to a "finally" batch callback.

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|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

static PendingDispatch dispatch(mixed ...$arguments)

Dispatch the job with the given arguments.

Parameters

mixed

...$arguments

Return Value

PendingDispatch

static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

Parameters

bool\|Closure	$boolean
mixed	...$arguments

Return Value

PendingDispatch|Fluent

static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

Parameters

bool\|Closure	$boolean
mixed	...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

Dispatch a command to its appropriate handler in the current process.

Queueable jobs will be dispatched to the "sync" queue.

Parameters

mixed

...$arguments

Return Value

mixed

static mixed dispatchAfterResponse(mixed ...$arguments)

Dispatch a command to its appropriate handler after the current process.

Parameters

mixed

...$arguments

Return Value

mixed

static PendingChain withChain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array

$chain

Return Value

PendingChain

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

int attempts()

Get the number of times the job has been attempted.

Return Value

int

void delete()

Delete the job from the queue.

Return Value

void

void fail(Throwable|string|null $exception = null)

Fail the job from the queue.

Parameters

Throwable|string|null

$exception

Return Value

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Release the job back into the queue after (n) seconds.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

void

$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job

$job

Return Value

$this

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null

$connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null

$queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null

$connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null

$queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|array|int|null

$delay

Return Value

$this

$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object

$middleware

Return Value

$this

$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array

$chain

Return Value

$this

$this prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

mixed

$job

Return Value

$this

$this appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed

$job

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed

$job

Return Value

string

Exceptions

RuntimeException

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable

Return Value

void

void __construct(PendingBatch $batch)

Create a new chained batch instance.

Parameters

PendingBatch

$batch

Return Value

void

static Collection prepareNestedBatches(Collection $jobs)

Prepare any nested batches within the given collection of jobs.

Parameters

Collection

$jobs

Return Value

Collection

void handle()

Handle the job.

Return Value

void

PendingBatch toPendingBatch()

Convert the chained batch instance into a pending batch.

Return Value

PendingBatch

protected PendingBatch attachRemainderOfChainToEndOfBatch(PendingBatch $batch)

Move the remainder of the chain to a "finally" batch callback.

Parameters

PendingBatch

$batch

Return Value

PendingBatch

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