1. class
  2. Illuminate
  3. Queue
  4. DatabaseQueue

DatabaseQueue

class DatabaseQueue extends Queue implements Queue (View source)

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

Marshal a push queue request and fire the job.

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

Push an array of jobs onto the queue.

void
setContainer( Container $container)

Set the IoC container instance.

from Queue
void
setEncrypter( Encrypter $crypt)

Set the encrypter instance.

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

Create a new database queue instance.

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 = array())

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.

Job|null
pop( string $queue = null)

Pop the next job off of the queue.

void
deleteReserved( string $queue, string $id)

Delete a reserved job from the queue.

Connection
getDatabase()

Get the underlying database instance.

int|null
getExpire()

Get the expiration time in seconds.

void
setExpire( int|null $seconds)

Set the expiration time in seconds.

Details

in Queue at line line 31
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

in Queue at line line 45
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

in Queue at line line 57
marshal()

Marshal a push queue request and fire the job.

Exceptions

RuntimeException

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

in Queue at line line 211
void setContainer( Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

in Queue at line line 222
void setEncrypter( Encrypter $crypt)

Set the encrypter instance.

Parameters

Encrypter $crypt

Return Value

void

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

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

at line line 80
mixed pushRaw( string $payload, string $queue = null, array $options = array())

Push a raw payload onto the queue.

Parameters

string $payload
string $queue
array $options

Return Value

mixed

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

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

at line line 159
Job|null pop( string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

at line line 242
void deleteReserved( string $queue, string $id)

Delete a reserved job from the queue.

Parameters

string $queue
string $id

Return Value

void

at line line 298
Connection getDatabase()

Get the underlying database instance.

Return Value

Connection

at line line 308
int|null getExpire()

Get the expiration time in seconds.

Return Value

int|null

at line line 319
void setExpire( int|null $seconds)

Set the expiration time in seconds.

Parameters

int|null $seconds

Return Value

void