Queueable
trait Queueable
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. |
|
| array|string|int|null | $messageGroup | The message group the job should be sent to. |
|
| null|array|callable | $deduplicator | The deduplicator callback the job should use to generate the deduplication ID. |
|
| string | $debounceOwner | The lock owner token for debounce supersession checks. |
|
| array|DateInterval|DateTimeInterface|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. |
|
| 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. |
Methods
Set the desired connection for the job.
Set the desired job deduplicator callback.
Set the desired connection for the chain.
Set the desired queue for the chain.
Set the desired delay in seconds for the job.
Set the delay for the job to zero seconds.
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.
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.
Assert that the job has the given chain of jobs attached to it.
Assert that the job has no remaining chained jobs.
Details
at line 92
Queueable
onConnection(UnitEnum|string|null $connection)
Set the desired connection for the job.
at line 104
Queueable
onQueue(UnitEnum|string|null $queue)
Set the desired queue for the job.
at line 118
Queueable
onGroup(array|UnitEnum|string|int|null $group)
Set the desired job message group.
This feature is only supported by some queues, such as Amazon SQS.
at line 130
Queueable
withDeduplicator(array|callable|null $deduplicator)
Set the desired job deduplicator callback.
This feature is only supported by some queues, such as Amazon SQS FIFO.
at line 142
Queueable
allOnConnection(UnitEnum|string|null $connection)
Set the desired connection for the chain.
at line 157
Queueable
allOnQueue(UnitEnum|string|null $queue)
Set the desired queue for the chain.
at line 172
Queueable
delay(array|DateInterval|DateTimeInterface|int|null $delay)
Set the desired delay in seconds for the job.
at line 182
Queueable
withoutDelay()
Set the delay for the job to zero seconds.
at line 192
Queueable
afterCommit()
Indicate that the job should be dispatched after all database transactions have committed.
at line 202
Queueable
beforeCommit()
Indicate that the job should not wait until database transactions have been committed before dispatching.
at line 212
Queueable
through(array|object $middleware)
Specify the middleware the job should be dispatched through.
at line 222
Queueable
chain(array $chain)
Set the jobs that should run if this job is successful.
at line 234
Queueable
prependToChain(mixed $job)
Prepend a job to the current chain so that it is run after the currently running job.
at line 248
Queueable
appendToChain(mixed $job)
Append a job to the end of the current chain.
at line 264
protected string
serializeJob(mixed $job)
Serialize a job for queuing.
at line 282
void
dispatchNextJobInChain()
Dispatch the next job on the chain.
at line 305
void
invokeChainCatchCallbacks(Throwable|null $e)
Invoke all of the chain's failed job callbacks.
at line 315
void
assertHasChain(array $expectedChain)
Assert that the job has the given chain of jobs attached to it.
at line 337
void
assertDoesntHaveChain()
Assert that the job has no remaining chained jobs.