PendingDispatch
class PendingDispatch (View source)
Traits
Properties
| protected mixed | $job | The job. |
|
| protected bool | $afterResponse | Indicates if the job should be dispatched immediately after sending the response. |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Store unique job information in the context in case we can't resolve the job on the queue side.
Remove the unique job information from the context.
Determine the cache store used by the unique job to acquire locks.
Get a configuration value from an attribute, falling back to a property.
Extract the value from an attribute instance.
Get an instance of the given attribute class from the target class or its parents.
Determine if a property declared on a child class overrides an inherited attribute.
Create a new pending job dispatch.
Set the desired connection for the job.
Set the desired queue for the job.
Set the desired job "group".
Set the desired job deduplicator callback.
Set the desired connection for the chain.
Set the desired queue for the chain.
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.
Set the jobs that should run if this job is successful.
Indicate that the job should be dispatched after the response is sent to the browser.
Determine if the job should be dispatched.
Acquire a debounce lock for the job and set its delay.
Get the underlying job instance.
Dynamically proxy methods to the underlying job.
Handle the object's destruction.
Details
$this|TWhenReturnType
when(TWhenParameter|TWhenParameter|null $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless(TUnlessParameter|TUnlessParameter|null $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
void
addUniqueJobInformationToContext(mixed $job)
Store unique job information in the context in case we can't resolve the job on the queue side.
void
removeUniqueJobInformationFromContext(mixed $job)
Remove the unique job information from the context.
protected string|null
getUniqueJobCacheStore(mixed $job)
Determine the cache store used by the unique job to acquire locks.
protected mixed
getAttributeValue(object $target, string $attributeClass, string|null $property = null, mixed $default = null)
Get a configuration value from an attribute, falling back to a property.
protected mixed
extractAttributeValue(object $instance)
Extract the value from an attribute instance.
protected object|null
getAttributeInstance(object $target, string $attributeClass, ReflectionClass|null $declaringClass = null)
Get an instance of the given attribute class from the target class or its parents.
protected bool
propertyOverridesAttribute(object $target, ReflectionClass $reflection, string|null $property, ReflectionClass $attributeDeclaringClass)
Determine if a property declared on a child class overrides an inherited attribute.
__construct(mixed $job)
Create a new pending job dispatch.
$this
onConnection(BackedEnum|string|null $connection)
Set the desired connection for the job.
$this
onQueue(BackedEnum|string|null $queue)
Set the desired queue for the job.
$this
onGroup(UnitEnum|string $group)
Set the desired job "group".
This feature is only supported by some queues, such as Amazon SQS.
$this
withDeduplicator(callable|null $deduplicator)
Set the desired job deduplicator callback.
This feature is only supported by some queues, such as Amazon SQS FIFO.
$this
allOnConnection(BackedEnum|string|null $connection)
Set the desired connection for the chain.
$this
allOnQueue(BackedEnum|string|null $queue)
Set the desired queue for the chain.
$this
delay(DateTimeInterface|DateInterval|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
chain(array $chain)
Set the jobs that should run if this job is successful.
$this
afterResponse(bool $afterResponse = true)
Indicate that the job should be dispatched after the response is sent to the browser.
protected bool
shouldDispatch()
Determine if the job should be dispatched.
protected void
acquireDebounceLock()
Acquire a debounce lock for the job and set its delay.
mixed
getJob()
Get the underlying job instance.
$this
__call(string $method, array $parameters)
Dynamically proxy methods to the underlying job.
void
__destruct()
Handle the object's destruction.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.