Queue
abstract class Queue
Traits
Properties
| 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 all 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
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.
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.
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.
Enqueue a job immediately using the given callback.
Determine if the job should be dispatched after all database transactions have committed.
Register a transaction rollback callback that releases the unique lock for the given job.
Register a transaction rollback callback that releases the debounce token for the given job.
Raise the job queueing event.
Raise the job queued event.
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
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 41
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 57
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
InteractsWithTime at line 65
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 15
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 44
protected mixed
extractAttributeValue(object $instance)
Extract the value from an attribute instance.
in
ReadsClassAttributes at line 54
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 70
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.
at line 82
mixed
pushOn(string|null $queue, object|string $job, mixed $data = '')
Push a new job onto the queue.
at line 91
mixed
laterOn(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 100
mixed
bulk(array $jobs, mixed $data = '', string|null $queue = null)
Push an array of jobs onto the queue.
at line 117
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 150
protected array
createPayloadArray(array|object|string $job, string|null $queue, mixed $data = '')
Create a payload array from the given job and data.
at line 160
protected array
createObjectPayload(object $job, string|null $queue)
Create a payload for an object-based queue handler.
at line 214
protected string
getDisplayName(object $job)
Get the display name for the given job.
at line 223
mixed
getJobTries(mixed $job)
Get the maximum number of attempts for an object-based queue handler.
at line 237
mixed
getJobBackoff(mixed $job)
Get the backoff for an object-based queue handler.
at line 257
mixed
getJobExpiration(mixed $job)
Get the expiration timestamp for an object-based queue handler.
at line 272
protected bool
jobShouldBeEncrypted(object $job)
Determine if the job should be encrypted.
at line 284
protected array
createStringPayload(array|string $job, string|null $queue, mixed $data)
Create a typical, string based queue payload array.
at line 307
static void
createPayloadUsing(callable|null $callback)
Register a callback to be executed when creating job payloads.
Boot-only. 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 319
protected array
withCreatePayloadHooks(string|null $queue, array $payload)
Create the given payload using any registered payload hooks.
at line 335
Queue
setAfterCommitDispatcher(Closure|null $dispatcher)
Set the dispatcher for after-commit queue operations.
at line 350
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 388
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 402
protected bool
shouldDispatchAfterCommit(object|string $job)
Determine if the job should be dispatched after all database transactions have committed.
at line 418
protected void
addUniqueJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)
Register a transaction rollback callback that releases the unique lock for the given job.
at line 434
protected void
addDebouncedJobRollbackCallback(DatabaseTransactionsManager $transactions, object|string $job)
Register a transaction rollback callback that releases the debounce token for the given job.
at line 452
protected void
raiseJobQueueingEvent(string|null $queue, object|string $job, string $payload, DateInterval|DateTimeInterface|int|null $delay)
Raise the job queueing event.
at line 473
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 492
string
getConnectionName()
Get the connection name for the queue.
at line 504
Queue
setConnectionName(string $name)
Set the connection name for the queue.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 514
array
getConfig()
Get the queue configuration array.
at line 526
Queue
setConfig(array $config)
Set the queue configuration array.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 536
Container
getContainer()
Get the container instance being used by the connection.
at line 548
Queue
setContainer(Container $container)
Set the IoC container instance.
Boot or tests only. Queue connection instances are cached on QueueManager; runtime use races across coroutines and changes every concurrent dispatch through this connection.
at line 558
static void
flushState()
Flush all static state.