Queueable
trait Queueable (View source)
Traits
| Dispatchable | |
| InteractsWithQueue | |
| Queueable | |
| SerializesModels | |
| InteractsWithTime | |
| SerializesAndRestoresModelIdentifiers |
Properties
| 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 |
| 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 |
| 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 |
Methods
| 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 |
| string | runTimeForHumans(float $startTime, float $endTime = null)
Given a start time, format the total run time for human readability. | 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 | withFakeQueueInteractions()
Indicate that queue interactions like fail, delete, and release should be faked. | from InteractsWithQueue |
| $this | assertDeleted()
Assert that the job was deleted from the queue. | from InteractsWithQueue |
| $this | assertFailed()
Assert that the job was manually failed. | from InteractsWithQueue |
| $this | assertReleased(DateTimeInterface|DateInterval|int $delay = null)
Assert that the job was released back onto the queue. | 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 | withoutDelay()
Set the delay for the job to zero seconds. | 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 | assertHasChain(array $expectedChain)
Assert that the job has the given chain of jobs attached to it. | from Queueable |
| void | assertDoesntHaveChain()
Assert that the job has no remaining chained jobs. | from Queueable |
| mixed | getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization. | from SerializesAndRestoresModelIdentifiers |
| mixed | getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization. | from SerializesAndRestoresModelIdentifiers |
| Collection | restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance. | from SerializesAndRestoresModelIdentifiers |
| Model | restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance. | from SerializesAndRestoresModelIdentifiers |
| TModel> | getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration. | from SerializesAndRestoresModelIdentifiers |
| array | __serialize()
Prepare the instance values for serialization. | from SerializesModels |
| void | __unserialize(array $values)
Restore the model after serialization. | from SerializesModels |
| mixed | getPropertyValue(ReflectionProperty $property)
Get the property value for the given property. | from SerializesModels |
Details
static PendingDispatch dispatch(mixed ...$arguments)
Dispatch the job with the given arguments.
static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)
Dispatch the job with the given arguments if the given truth test passes.
static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)
Dispatch the job with the given arguments unless the given truth test passes.
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.
static mixed dispatchAfterResponse(mixed ...$arguments)
Dispatch a command to its appropriate handler after the current process.
static PendingChain withChain(array $chain)
Set the jobs that should run if this job is successful.
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int currentTime()
Get the current system time as a UNIX timestamp.
protected string runTimeForHumans(float $startTime, float $endTime = null)
Given a start time, format the total run time for human readability.
int attempts()
Get the number of times the job has been attempted.
void delete()
Delete the job from the queue.
void fail(Throwable|string|null $exception = null)
Fail the job from the queue.
void release(DateTimeInterface|DateInterval|int $delay = 0)
Release the job back into the queue after (n) seconds.
$this withFakeQueueInteractions()
Indicate that queue interactions like fail, delete, and release should be faked.
$this assertDeleted()
Assert that the job was deleted from the queue.
$this assertFailed()
Assert that the job was manually failed.
$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)
Assert that the job was released back onto the queue.
$this setJob(Job $job)
Set the base queue job instance.
$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 withoutDelay()
Set the delay for the job to zero seconds.
$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.
void assertHasChain(array $expectedChain)
Assert that the job has the given chain of jobs attached to it.
void assertDoesntHaveChain()
Assert that the job has no remaining chained jobs.
protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
protected mixed getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
protected Collection restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
Model restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration.
array __serialize()
Prepare the instance values for serialization.
void __unserialize(array $values)
Restore the model after serialization.
protected mixed getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Queue/Queueable.html
