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|array|int|null | $delay | The number of seconds before the job should be made available. |
|
| bool|null | $afterCommit | Indicates whether the job should be dispatched after all database transactions have committed. |
|
| array | $middleware | The middleware the job should be dispatched through. |
|
| array | $chained | The jobs that should run if this job is successful. |
Methods
Set the desired connection for the job.
Set the desired queue for the job.
Set the desired connection for the chain.
Set the desired queue for the chain.
Set the desired delay in seconds for the job.
Indicate that the job should be dispatched after all database transactions have committed.
Indicate that the job should not wait until database transactions have been committed before dispatching.
Specify the middleware the job should be dispatched through.
Set the jobs that should run if this job is successful.
Prepend a job to the current chain so that it is run after the currently running job.
Append a job to the end of the current chain.
Serialize a job for queuing.
Dispatch the next job on the chain.
Details
$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|array|int|null $delay)
Set the desired delay in seconds for the job.
$this
afterCommit()
Indicate that the job should be dispatched after all database transactions have committed.
$this
beforeCommit()
Indicate that the job should not wait until database transactions have been committed before dispatching.
$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.
$this
prependToChain(mixed $job)
Prepend a job to the current chain so that it is run after the currently running job.
$this
appendToChain(mixed $job)
Append a job to the end of the current chain.
protected 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.