1. class
  2. Illuminate
  3. \
  4. Queue
  5. \
  6. Queue

Queue

abstract class Queue

Traits

InteractsWithTime

Properties

protected Container $container

The IoC container instance.
protected Encrypter $encrypter

The encrypter implementation.
protected string $connectionName

The connection name for the queue.

Methods

int
secondsUntil(DateTimeInterface $delay)

Get the number of seconds until the given DateTime.

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

Get the "available at" UNIX timestamp.

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, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

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

Push an array of jobs onto the queue.

string
createPayload(string $job, mixed $data = '', string $queue = null)

Create a payload string from the given job and data.

array
createPayloadArray(string $job, mixed $data = '', string $queue = null)

Create a payload array from the given job and data.

array
createObjectPayload(mixed $job)

Create a payload for an object-based queue handler.

string
getDisplayName(mixed $job)

Get the display name for the given job.

array
createStringPayload(string $job, mixed $data)

Create a typical, string based queue payload array.

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

in InteractsWithTime at line 16
protected int secondsUntil(DateTimeInterface $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface $delay

Return Value

int

in InteractsWithTime at line 29
protected int availableAt(DateTimeInterface|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|int $delay

Return Value

int

in InteractsWithTime at line 41
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

at line 40
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

at line 54
mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string $queue
DateTime|int $delay
string $job
mixed $data

Return Value

mixed

at line 67
mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string $queue

Return Value

mixed

at line 84
protected string createPayload(string $job, mixed $data = '', string $queue = null)

Create a payload string from the given job and data.

Parameters

string $job
mixed $data
string $queue

Return Value

string

Exceptions

InvalidPayloadException

at line 105
protected array createPayloadArray(string $job, mixed $data = '', string $queue = null)

Create a payload array from the given job and data.

Parameters

string $job
mixed $data
string $queue

Return Value

array

at line 118
protected array createObjectPayload(mixed $job)

Create a payload for an object-based queue handler.

Parameters

mixed $job

Return Value

array

at line 138
protected string getDisplayName(mixed $job)

Get the display name for the given job.

Parameters

mixed $job

Return Value

string

at line 151
protected array createStringPayload(string $job, mixed $data)

Create a typical, string based queue payload array.

Parameters

string $job
mixed $data

Return Value

array

at line 165
string getConnectionName()

Get the connection name for the queue.

Return Value

string

at line 176
$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this

at line 189
void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void