Queue

class Queue (View source)

Properties

protected Container $container The IoC container instance.

Methods

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.
marshal() deprecated

Marshal a push queue request and fire the job.
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 createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.
mixed prepareQueueableEntities(mixed $data)

Prepare any queueable entities for storage in the queue.
mixed prepareQueueableEntity(mixed $value)

Prepare a single queueable entity for storage on the queue.
string createClosurePayload(Closure $job, mixed $data)

Create a payload string for the given Closure job.
string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.
int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.
int getTime()

Get the current UNIX timestamp.
void setContainer(Container $container)

Set the IoC container instance.
void setEncrypter(Encrypter $crypt)

Set the encrypter instance.

Details

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, 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

marshal() deprecated

deprecated

since version 5.1.

Marshal a push queue request and fire the job.

Exceptions

RuntimeException

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

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

protected array createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

Parameters

string $job
mixed $data

Return Value

array

protected mixed prepareQueueableEntities(mixed $data)

Prepare any queueable entities for storage in the queue.

Parameters

mixed $data

Return Value

mixed

protected mixed prepareQueueableEntity(mixed $value)

Prepare a single queueable entity for storage on the queue.

Parameters

mixed $value

Return Value

mixed

protected string createClosurePayload(Closure $job, mixed $data)

Create a payload string for the given Closure job.

Parameters

Closure $job
mixed $data

Return Value

string

protected string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

Parameters

string $payload
string $key
string $value

Return Value

string

protected int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

Parameters

DateTime|int $delay

Return Value

int

protected int getTime()

Get the current UNIX timestamp.

Return Value

int

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void setEncrypter(Encrypter $crypt)

Set the encrypter instance.

Parameters

Encrypter $crypt

Return Value

void

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