Queue

abstract class Queue (View source)

Traits

InteractsWithTime

Properties

protected Container $container The IoC container instance.
protected string $connectionName The connection name for the queue.
static protected callable[] $createPayloadCallbacks The create payload callbacks.

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
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 the queue after a delay.
void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.
string createPayload(string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.
array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.
array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.
string getDisplayName(object $job)

Get the display name for the given job.
mixed getJobRetryDelay(mixed $job)

Get the retry delay for an object-based queue handler.
mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.
array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.
static void createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.
array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.
string getConnectionName()

Get the connection name for the queue.
$this setConnectionName(string $name)

Set the connection name for the queue.
void setContainer(Container $container)

Set the IoC container instance.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

mixed pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

Parameters

string $queue
string $job
mixed $data

Return Value

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string $queue
DateTimeInterface|DateInterval|int $delay
string $job
mixed $data

Return Value

mixed

void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string|null $queue

Return Value

void

protected string createPayload(string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

Parameters

string|object $job
string $queue
mixed $data

Return Value

string

Exceptions

InvalidPayloadException

protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.

Parameters

string|object $job
string $queue
mixed $data

Return Value

array

protected array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.

Parameters

object $job
string $queue

Return Value

array

protected string getDisplayName(object $job)

Get the display name for the given job.

Parameters

object $job

Return Value

string

mixed getJobRetryDelay(mixed $job)

Get the retry delay for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

protected array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

Parameters

string $job
string $queue
mixed $data

Return Value

array

static void createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.

Parameters

callable $callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

Parameters

string $queue
array $payload

Return Value

array

string getConnectionName()

Get the connection name for the queue.

Return Value

string

$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

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