class CallQueuedClosure implements ShouldQueue (View source)
| Batchable | |
| Dispatchable | |
| InteractsWithQueue | |
| Queueable | |
| SerializesModels | |
| InteractsWithTime | |
| SerializesAndRestoresModelIdentifiers |
| 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 |
| 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 |
| SerializableClosure | $closure | The serializable Closure instance. | |
| array | $failureCallbacks | The callbacks that should be executed on failure. | |
| bool | $deleteWhenMissingModels | Indicate if the job should be deleted when models are missing. |
| 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 |
| 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 |
| void | __construct(SerializableClosure $closure)
Create a new job instance. | |
| static CallQueuedClosure | create(Closure $job)
Create a new job instance. | |
| void | handle(Container $container)
Execute the job. | |
| $this | onFailure(callable $callback)
Add a callback to be executed if the job fails. | |
| void | failed(Throwable $e)
Handle a job failure. | |
| string | displayName()
Get the display name for the queued job. |
Get the batch instance for the job, if applicable.
Determine if the batch is still active and processing.
Set the batch ID on the job.
Indicate that the job should use a fake batch.
Dispatch the job with the given arguments.
Dispatch the job with the given arguments if the given truth test passes.
Dispatch the job with the given arguments unless the given truth test passes.
Dispatch a command to its appropriate handler in the current process.
Queueable jobs will be dispatched to the "sync" queue.
Dispatch a command to its appropriate handler after the current process.
Set the jobs that should run if this job is successful.
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Get the current system time as a UNIX timestamp.
Given a start time, format the total run time for human readability.
Get the number of times the job has been attempted.
Delete the job from the queue.
Fail the job from the queue.
Release the job back into the queue after (n) seconds.
Indicate that queue interactions like fail, delete, and release should be faked.
Assert that the job was deleted from the queue.
Assert that the job was manually failed.
Assert that the job was released back onto the queue.
Set the base queue job instance.
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.
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.
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.
Invoke all of the chain's failed job callbacks.
Assert that the job has the given chain of jobs attached to it.
Assert that the job has no remaining chained jobs.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Restore a queueable collection instance.
Restore the model from the model identifier instance.
Get the query for model restoration.
Prepare the instance values for serialization.
Restore the model after serialization.
Get the property value for the given property.
Create a new job instance.
Create a new job instance.
Execute the job.
Add a callback to be executed if the job fails.
Handle a job failure.
Get the display name for the queued job.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/CallQueuedClosure.html