CallQueuedClosure
class CallQueuedClosure implements ShouldQueue (View source)
Traits
| Batchable | |
| Dispatchable | |
| InteractsWithQueue | |
| Queueable | |
| SerializesModels | |
| InteractsWithTime | |
| SerializesAndRestoresModelIdentifiers |
Properties
| 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 |
| 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 |
| 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 |
| 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. |
Methods
| 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 $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 |
| 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 | 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 | 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 |
| mixed | getSerializedPropertyValue(mixed $value) 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 |
| Builder | getQueryForModelRestoration(Model $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. |
Details
Batch|null batch()
Get the batch instance for the job, if applicable.
bool batching()
Determine if the batch is still active and processing.
$this withBatchId(string $batchId)
Set the batch ID on the job.
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)
Indicate that the job should use a fake batch.
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.
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 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 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.
protected mixed getSerializedPropertyValue(mixed $value)
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 Builder getQueryForModelRestoration(Model $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.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/CallQueuedClosure.html