Queue
abstract class Queue
Traits
Properties
| protected bool | $dispatchViaOutbox | Whether this connection stages jobs through the outbox by default. |
from StagesOutboxJobs |
| protected Container | $container | The IoC container instance. |
|
| protected string | $connectionName | The connection name for the queue. |
|
| protected array | $config | The original configuration for the queue. |
|
| protected bool | $dispatchAfterCommit | Indicates that jobs should be dispatched after the open parent database transactions have committed. |
|
| protected null|Queue): mixed): mixed | $afterCommitDispatcher | Dispatch an after-commit operation through its live queue owner. |
|
| static protected callable[] | $createPayloadCallbacks | The create payload callbacks. |
Methods
Determine whether the job selects outbox delivery.
Run a child attempt or handler with its own forwarding context.
Determine whether this driver needs SQL staging for the selected job.
Select an explicit transaction for a local or failover after-commit fallback.
Stage a single job through its normal guarded enqueue lifecycle.
Stage selected jobs in owner groups and return the direct remainder.
Build a byte-preserving row from a finalized payload.
Expand the logical destination without applying publication-time forwarding.
Add metadata required while the original job is still available.
Capture transport options that cannot be recovered from the stored envelope.
Determine when a stored message may first be published.
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.
Given a start time, format the total run time for human readability.
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.
Resolve the default connection name for a given queueable instance.
Resolve the default queue name for a given queueable instance.
Get the container that owns the queue routes.
Push a new job onto the queue.
Push a new job onto a specific queue after (n) seconds.
Push an array of jobs onto the queue.
Prepare payloads and delays for a set-based enqueue operation.
Get the delay configured on the given job.
Run an operation with its own log context, then restore the caller.
Create a payload string from the given job and data.
Create a payload array from the given job and data.
Create a payload for an object-based queue handler.
Get the display name for the given job.
Get the maximum number of attempts for an object-based queue handler.
Get the backoff for an object-based queue handler.
Get the expiration timestamp for an object-based queue handler.
Determine if the job should be encrypted.
Create a typical, string based queue payload array.
Register a callback to be executed when creating job payloads.
Create the given payload using any registered payload hooks.
Set the dispatcher for after-commit queue operations.
Enqueue a job using the given callback.
Defer an enqueue operation until the applicable transaction commits.
Defer a batch enqueue operation until the applicable transaction commits.
Run deferred work with its dispatch locks and optional deferredDispatchFailed job hook.
Enqueue a job immediately using the given callback.
Prepare a finalized payload for storage without changing lifecycle event correlation.
Handle a payload after the queue has accepted it.
Notify every batch member and return the first ordinary notification failure.
Notify every batch member of a failure or cancellation, reporting listener errors so they cannot replace it.
Report a failure that must not replace the primary error, without swallowing cancellation.
Finalize an encoded payload immediately before queueing.
Partition jobs by whether they should be deferred until the active transaction commits.
Determine if the job should be dispatched after the open parent database transactions have committed.
Register a transaction rollback callback that releases the job's locks.
Create a callback that releases the job's locks.
Mark a job's dispatch locks as accepted by the queue.
Raise the job queueing event.
Raise the job queueing failed event, or the canceled event when cancellation stopped the job.
Raise the job queueing canceled event.
Raise the job queued event.
Normalize an enum queue name without applying defaults or forwarding.
Get the routed queue name for the given queue.
Get the connection name for the queue.
Set the connection name for the queue.
Get the queue configuration array.
Get the container instance being used by the connection.
Flush all static state.
Details
in
StagesOutboxJobs at line 32
protected bool
shouldDispatchViaOutbox(object|string $job)
Determine whether the job selects outbox delivery.
in
StagesOutboxJobs at line 44
protected mixed
withOutboxForwarding(array|null $forwarded, callable $callback)
Run a child attempt or handler with its own forwarding context.
in
StagesOutboxJobs at line 68
protected bool
shouldStageViaOutbox(object|string $job)
Determine whether this driver needs SQL staging for the selected job.
in
StagesOutboxJobs at line 76
protected string|null
resolveOutboxCommitConnection(DatabaseTransactionsManager $transactions, object|string $job)
Select an explicit transaction for a local or failover after-commit fallback.
in
StagesOutboxJobs at line 97
protected string
enqueueViaOutbox(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay)
Stage a single job through its normal guarded enqueue lifecycle.
in
StagesOutboxJobs at line 124
protected array
stageOutboxJobs(array $jobs, mixed $data, string|null $queue)
Stage selected jobs in owner groups and return the direct remainder.
in
StagesOutboxJobs at line 207
protected array
prepareOutboxRow(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay)
Build a byte-preserving row from a finalized payload.
in
StagesOutboxJobs at line 245
protected string|null
resolveOutboxQueue(string|null $queue)
Expand the logical destination without applying publication-time forwarding.
in
StagesOutboxJobs at line 253
protected string
preparePayloadForOutbox(object|string $job, string $payload)
Add metadata required while the original job is still available.
in
StagesOutboxJobs at line 261
protected array
prepareOutboxOptions(object|string $job, string|null $queue, string $payload)
Capture transport options that cannot be recovered from the stored envelope.
in
StagesOutboxJobs at line 269
protected int
availableAtForOutbox(string|null $queue, int|null $deliverAt)
Determine when a stored message may first be published.
in
InteractsWithTime at line 17
protected int
secondsUntil(DateInterval|DateTimeInterface|int $delay)
Get the number of seconds until the given DateTime.
in
InteractsWithTime at line 29
protected int
availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)
Get the "available at" UNIX timestamp.
in
InteractsWithTime at line 47
protected DateTimeInterface|int
parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)
If the given value is an interval, convert it to a DateTime instance.
in
InteractsWithTime at line 63
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
InteractsWithTime at line 71
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
in
ReadsClassAttributes at line 17
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.
in
ReadsClassAttributes at line 46
protected mixed
extractAttributeValue(object $instance)
Extract the value from an attribute instance.
in
ReadsClassAttributes at line 58
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.
in
ReadsClassAttributes at line 74
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.
in
ResolvesQueueRoutes at line 19
string|null
resolveConnectionFromQueueRoute(object $queueable, UnitEnum|string|null $queue = null)
Resolve the default connection name for a given queueable instance.
in
ResolvesQueueRoutes at line 27
string|null
resolveQueueFromQueueRoute(object $queueable)
Resolve the default queue name for a given queueable instance.
in
ResolvesQueueRoutes at line 35
protected QueueRoutes
queueRoutes()
Get the queue routes manager instance.
at line 994
protected Container
queueRoutesContainer()
Get the container that owns the queue routes.
at line 98
mixed
pushOn(UnitEnum|string|null $queue, object|string $job, mixed $data = '')
Push a new job onto the queue.
at line 106
mixed
laterOn(UnitEnum|string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
at line 114
mixed
bulk(array $jobs, mixed $data = '', UnitEnum|string|null $queue = null)
Push an array of jobs onto the queue.
at line 137
protected array
prepareBatchJobs(array $jobs, mixed $data, string|null $queue)
Prepare payloads and delays for a set-based enqueue operation.
at line 156
protected mixed
getJobDelay(object|string $job)
Get the delay configured on the given job.
at line 170
protected mixed
withLogContext(Repository|null $context, Closure $callback)
Run an operation with its own log context, then restore the caller.
at line 193
protected string
createPayload(array|object|string $job, string|null $queue, mixed $data = '', DateInterval|DateTimeInterface|int|null $delay = null)
Create a payload string from the given job and data.
at line 226
protected array
createPayloadArray(array|object|string $job, string|null $queue, mixed $data = '')
Create a payload array from the given job and data.
at line 238
protected array
createObjectPayload(object $job, string|null $queue)
Create a payload for an object-based queue handler.
at line 309
protected string
getDisplayName(object $job)
Get the display name for the given job.
at line 319
mixed
getJobTries(mixed $job)
Get the maximum number of attempts for an object-based queue handler.
at line 333
mixed
getJobBackoff(mixed $job)
Get the backoff for an object-based queue handler.
at line 353
mixed
getJobExpiration(mixed $job)
Get the expiration timestamp for an object-based queue handler.
at line 369
protected bool
jobShouldBeEncrypted(object $job)
Determine if the job should be encrypted.
at line 381
protected array
createStringPayload(array|string $job, string|null $queue, mixed $data)
Create a typical, string based queue payload array.
at line 406
static void
createPayloadUsing(callable|null $callback)
Register a callback to be executed when creating job payloads.
The callback persists in a static property for the worker lifetime and runs on every subsequent payload creation across all coroutines. Passing null clears the registry.
at line 419
protected array
withCreatePayloadHooks(string|null $queue, array $payload)
Create the given payload using any registered payload hooks.
at line 440
Queue
setAfterCommitDispatcher(Closure|null $dispatcher)
Set the dispatcher for after-commit queue operations.
Queue connection instances are cached on QueueManager; replacing the dispatcher on a shared connection changes every subsequent after-commit enqueue through it.
at line 456
protected mixed
enqueueUsing(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay, callable $callback)
Enqueue a job using the given callback.
The callback receives the queue that owns the operation first so deferred pooled dispatch never retains a borrowed queue.
at line 495
protected void
deferEnqueueAfterCommit(DatabaseTransactionsManager $transactions, object|string $job, Closure $enqueue)
Defer an enqueue operation until the applicable transaction commits.
at line 509
protected void
deferBatchEnqueueAfterCommit(DatabaseTransactionsManager $transactions, array $jobs, Closure $enqueue, string|null $connection = null)
Defer a batch enqueue operation until the applicable transaction commits.
at line 552
static protected mixed
runDeferredEnqueue(array $jobs, Closure $operation)
Run deferred work with its dispatch locks and optional deferredDispatchFailed job hook.
at line 589
protected mixed
enqueueNow(object|string $job, string $payload, string|null $queue, DateInterval|DateTimeInterface|int|null $delay, callable $callback)
Enqueue a job immediately using the given callback.
at line 631
protected string
preparePayloadForPush(object|string $job, string $payload, string|null $queue)
Prepare a finalized payload for storage without changing lifecycle event correlation.
at line 639
protected void
handlePayloadPushed(string $payload, string|null $queue)
Handle a payload after the queue has accepted it.
at line 656
protected Throwable|null
notifyBatchMembers(array $members, Closure ...$notifications)
Notify every batch member and return the first ordinary notification failure.
A canceled notification does not skip the remaining members; the first cancellation is rethrown once every member has been notified, and the ordinary failure it displaces is reported.
at line 693
protected void
notifyBatchMembersOfFailure(array $members, Closure $notification)
Notify every batch member of a failure or cancellation, reporting listener errors so they cannot replace it.
at line 703
protected void
reportSecondaryFailure(Throwable $exception)
Report a failure that must not replace the primary error, without swallowing cancellation.
at line 730
protected string
finalizePayloadForQueueing(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Finalize an encoded payload immediately before queueing.
at line 765
protected array
partitionJobsByAfterCommit(array $jobs, DatabaseTransactionsManager|null $transactions)
Partition jobs by whether they should be deferred until the active transaction commits.
at line 784
protected bool
shouldDispatchAfterCommit(object|string $job)
Determine if the job should be dispatched after the open parent database transactions have committed.
at line 806
protected void
addJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job, string|null $connection = null)
Register a transaction rollback callback that releases the job's locks.
at line 818
protected Closure|null
createJobRollbackCallback(object|string $job)
Create a callback that releases the job's locks.
at line 831
protected void
acceptDispatchLocks(object|string $job)
Mark a job's dispatch locks as accepted by the queue.
at line 843
protected void
raiseJobQueueingEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Raise the job queueing event.
at line 864
protected void
raiseJobQueueingFailedEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay, Throwable $exception, bool $sendAttempted = true)
Raise the job queueing failed event, or the canceled event when cancellation stopped the job.
at line 908
protected void
raiseJobQueueingCanceledEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay, Throwable $cancellation, bool $sendAttempted, bool $queued = false, Throwable|null $exception = null)
Raise the job queueing canceled event.
The cancellation is already propagating, so a listener failure is reported instead of replacing it.
at line 951
protected void
raiseJobQueuedEvent(string|null $queue, mixed $jobId, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Raise the job queued event.
at line 978
protected string|null
normalizeQueue(UnitEnum|string|null $queue)
Normalize an enum queue name without applying defaults or forwarding.
at line 986
protected string
resolveQueue(string $queue)
Get the routed queue name for the given queue.
at line 1002
string
getConnectionName()
Get the connection name for the queue.
at line 1016
Queue
setConnectionName(string $name)
Set the connection name for the queue.
Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 1027
array
getConfig()
Get the queue configuration array.
at line 1041
Queue
setConfig(array $config)
Set the queue configuration array.
Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 1053
Container
getContainer()
Get the container instance being used by the connection.
at line 1065
Queue
setContainer(Container $container)
Set the IoC container instance.
Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 1076
static void
flushState()
Flush all static state.