W3cubDocs

/Laravel 8

Queueable

trait Queueable (View source)

Properties

string|null $connection The name of the connection the job should be sent to.
string|null $queue The name of the queue the job should be sent to.
string|null $chainConnection The name of the connection the chain should be sent to.
string|null $chainQueue The name of the queue the chain should be sent to.
array|null $chainCatchCallbacks The callbacks to be executed on chain failure.
DateTimeInterface|DateInterval|int|null $delay The number of seconds before the job should be made available.
array $middleware The middleware the job should be dispatched through.
array $chained The jobs that should run if this job is successful.

Methods

$this onConnection(string|null $connection)

Set the desired connection for the job.
$this onQueue(string|null $queue)

Set the desired queue for the job.
$this allOnConnection(string|null $connection)

Set the desired connection for the chain.
$this allOnQueue(string|null $queue)

Set the desired queue for the chain.
$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay for the job.
$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.
$this chain(array $chain)

Set the jobs that should run if this job is successful.
string serializeJob(mixed $job)

Serialize a job for queuing.
void dispatchNextJobInChain()

Dispatch the next job on the chain.
void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Details

$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|int|null $delay)

Set the desired delay for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

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

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

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

Return Value

void

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