DatabaseQueue

class DatabaseQueue extends Queue implements Queue (View source)

Properties

protected Container $container The IoC container instance. from Queue
protected Encrypter $encrypter The encrypter implementation. from Queue
protected Connection $database The database connection instance.
protected string $table The database table that holds the jobs.
protected string $default The name of the default queue.
protected int|null $expire The expiration time of a job.

Methods

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

Push a new job onto the queue.

 from Queue
mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

 from Queue
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.

 from Queue
array createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

 from Queue
string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

 from Queue
int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

 from Queue
int getTime()

Get the current UNIX timestamp.

 from Queue
void setContainer(Container $container)

Set the IoC container instance.

 from Queue
void __construct(Connection $database, string $table, string $default = 'default', int $expire = 60)

Create a new database queue instance.
int size(string $queue = null)

Get the size of the queue.
mixed push(string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue.
mixed pushRaw(string $payload, string $queue = null, array $options = [])

Push a raw payload onto the queue.
mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.
mixed release(string $queue, StdClass $job, int $delay)

Release a reserved job back onto the queue.
mixed pushToDatabase(DateTime|int $delay, string|null $queue, string $payload, int $attempts)

Push a raw payload to the database with a given delay.
Job|null pop(string $queue = null)

Pop the next job off of the queue.
StdClass|null getNextAvailableJob(string|null $queue)

Get the next available job for the queue.
void isAvailable(Builder $query)

Modify the query to check for available jobs.
void isReservedButExpired(Builder $query)

Modify the query to check for jobs that are reserved but have expired.
stdClass markJobAsReserved(stdClass $job)

Mark the given job ID as reserved.
void deleteReserved(string $queue, string $id)

Delete a reserved job from the queue.
int getAvailableAt(DateTime|int $delay)

Get the "available at" UNIX timestamp.
array buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts)

Create an array to insert for the given job.
string getQueue(string|null $queue)

Get the queue or return the default.
Connection getDatabase()

Get the underlying database 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

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

Exceptions

InvalidArgumentException

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

Create a typical, "plain" queue payload array.

Parameters

string $job
mixed $data

Return Value

array

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

Exceptions

InvalidArgumentException

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 __construct(Connection $database, string $table, string $default = 'default', int $expire = 60)

Create a new database queue instance.

Parameters

Connection $database
string $table
string $default
int $expire

Return Value

void

int size(string $queue = null)

Get the size of the queue.

Parameters

string $queue

Return Value

int

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

Push a new job onto the queue.

Parameters

string $job
mixed $data
string $queue

Return Value

mixed

mixed pushRaw(string $payload, string $queue = null, array $options = [])

Push a raw payload onto the queue.

Parameters

string $payload
string $queue
array $options

Return Value

mixed

mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.

Parameters

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

Return Value

mixed

mixed release(string $queue, StdClass $job, int $delay)

Release a reserved job back onto the queue.

Parameters

string $queue
StdClass $job
int $delay

Return Value

mixed

protected mixed pushToDatabase(DateTime|int $delay, string|null $queue, string $payload, int $attempts)

Push a raw payload to the database with a given delay.

Parameters

DateTime|int $delay
string|null $queue
string $payload
int $attempts

Return Value

mixed

Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

protected StdClass|null getNextAvailableJob(string|null $queue)

Get the next available job for the queue.

Parameters

string|null $queue

Return Value

StdClass|null

protected void isAvailable(Builder $query)

Modify the query to check for available jobs.

Parameters

Builder $query

Return Value

void

protected void isReservedButExpired(Builder $query)

Modify the query to check for jobs that are reserved but have expired.

Parameters

Builder $query

Return Value

void

protected stdClass markJobAsReserved(stdClass $job)

Mark the given job ID as reserved.

Parameters

stdClass $job

Return Value

stdClass

void deleteReserved(string $queue, string $id)

Delete a reserved job from the queue.

Parameters

string $queue
string $id

Return Value

void

protected int getAvailableAt(DateTime|int $delay)

Get the "available at" UNIX timestamp.

Parameters

DateTime|int $delay

Return Value

int

protected array buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts)

Create an array to insert for the given job.

Parameters

string|null $queue
string $payload
int $availableAt
int $attempts

Return Value

array

protected string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

Connection getDatabase()

Get the underlying database instance.

Return Value

Connection

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