CallQueuedClosure

class CallQueuedClosure implements ShouldQueue (View source)

Traits

Batchable
Dispatchable
InteractsWithQueue
Queueable
SerializesModels
SerializesAndRestoresModelIdentifiers

Properties

string $batchId The batch ID (if applicable). from Batchable
Job $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|int|null $delay The number of seconds before the job should be made available. 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
static PendingDispatch dispatch()

Dispatch the job with the given arguments.

 from Dispatchable
static PendingDispatch|Fluent dispatchIf($boolean, ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

 from Dispatchable
static PendingDispatch|Fluent dispatchUnless($boolean, ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

 from Dispatchable
static mixed dispatchSync()

Dispatch a command to its appropriate handler in the current process.

 from Dispatchable
static mixed dispatchNow()

Dispatch a command to its appropriate handler in the current process.

 from Dispatchable
static mixed dispatchAfterResponse()

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 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|null $exception = null)

Fail the job from the queue.

 from InteractsWithQueue
void release(int $delay = 0)

Release the job back into 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|int|null $delay)

Set the desired delay for the job.

 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
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 __sleep()

Prepare the instance for serialization.

 from SerializesModels
void __wakeup()

Restore the model after serialization.

 from SerializesModels
array __serialize()

Prepare the instance values for serialization.

 from SerializesModels
array __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(Exception $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.

Return Value

Batch|null

bool batching()

Determine if the batch is still active and processing.

Return Value

bool

$this withBatchId(string $batchId)

Set the batch ID on the job.

Parameters

string $batchId

Return Value

$this

static PendingDispatch dispatch()

Dispatch the job with the given arguments.

Return Value

PendingDispatch

static PendingDispatch|Fluent dispatchIf($boolean, ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

Parameters

$boolean
...$arguments

Return Value

PendingDispatch|Fluent

static PendingDispatch|Fluent dispatchUnless($boolean, ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

Parameters

$boolean
...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync()

Dispatch a command to its appropriate handler in the current process.

Queuable jobs will be dispatched to the "sync" queue.

Return Value

mixed

static mixed dispatchNow()

Dispatch a command to its appropriate handler in the current process.

Return Value

mixed

static mixed dispatchAfterResponse()

Dispatch a command to its appropriate handler after the current process.

Return Value

mixed

static PendingChain withChain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

PendingChain

int attempts()

Get the number of times the job has been attempted.

Return Value

int

void delete()

Delete the job from the queue.

Return Value

void

void fail(Throwable|null $exception = null)

Fail the job from the queue.

Parameters

Throwable|null $exception

Return Value

void

void release(int $delay = 0)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job $job

Return Value

$this

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null $queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

protected mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

Parameters

mixed $value

Return Value

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

protected Builder getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

Parameters

Model $model
array|int $ids

Return Value

Builder

array __sleep()

Prepare the instance for serialization.

Return Value

array

void __wakeup()

Restore the model after serialization.

Return Value

void

array __serialize()

Prepare the instance values for serialization.

Return Value

array

array __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

array

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

void __construct(SerializableClosure $closure)

Create a new job instance.

Parameters

SerializableClosure $closure

Return Value

void

static CallQueuedClosure create(Closure $job)

Create a new job instance.

Parameters

Closure $job

Return Value

CallQueuedClosure

void handle(Container $container)

Execute the job.

Parameters

Container $container

Return Value

void

$this onFailure(callable $callback)

Add a callback to be executed if the job fails.

Parameters

callable $callback

Return Value

$this

void failed(Exception $e)

Handle a job failure.

Parameters

Exception $e

Return Value

void

string displayName()

Get the display name for the queued job.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/CallQueuedClosure.html