Queue
abstract class Queue (View source)
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. |
|
| static protected callable[] | $createPayloadCallbacks | The create payload callbacks. |
Methods
Get the number of seconds until the given DateTime.
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.
Enqueue a job using the given callback.
Determine if the job should be dispatched after all database transactions have committed.
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.
Set the queue configuration array.
Get the container instance being used by the connection.
Details
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.
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
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.
mixed
pushOn(string $queue, string $job, mixed $data = '')
Push a new job onto the queue.
mixed
laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
void
bulk(array $jobs, mixed $data = '', string|null $queue = null)
Push an array of jobs onto the queue.
protected string
createPayload(Closure|string|object $job, string $queue, mixed $data = '', DateTimeInterface|DateInterval|int|null $delay = null)
Create a payload string from the given job and data.
protected array
createPayloadArray(string|object $job, string $queue, mixed $data = '')
Create a payload array from the given job and data.
protected array
createObjectPayload(object $job, string $queue)
Create a payload for an object-based queue handler.
protected string
getDisplayName(object $job)
Get the display name for the given job.
mixed
getJobTries(mixed $job)
Get the maximum number of attempts for an object-based queue handler.
mixed
getJobBackoff(mixed $job)
Get the backoff for an object-based queue handler.
mixed
getJobExpiration(mixed $job)
Get the expiration timestamp for an object-based queue handler.
protected bool
jobShouldBeEncrypted(object $job)
Determine if the job should be encrypted.
protected array
createStringPayload(string $job, string $queue, mixed $data)
Create a typical, string based queue payload array.
static void
createPayloadUsing(callable|null $callback)
Register a callback to be executed when creating job payloads.
protected array
withCreatePayloadHooks(string $queue, array $payload)
Create the given payload using any registered payload hooks.
protected mixed
enqueueUsing(Closure|string|object $job, string $payload, string|null $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Enqueue a job using the given callback.
protected bool
shouldDispatchAfterCommit(Closure|string|object $job)
Determine if the job should be dispatched after all database transactions have committed.
protected void
raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Raise the job queueing event.
protected void
raiseJobQueuedEvent(string|null $queue, string|int|null $jobId, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)
Raise the job queued event.
string
getConnectionName()
Get the connection name for the queue.
$this
setConnectionName(string $name)
Set the connection name for the queue.
array
getConfig()
Get the queue configuration array.
$this
setConfig(array $config)
Set the queue configuration array.
Container
getContainer()
Get the container instance being used by the connection.
void
setContainer(Container $container)
Set the IoC container instance.
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.