Queue
in
Table of Contents
- bulk() : mixed
- Push an array of jobs onto the queue.
- getConnectionName() : string
- Get the connection name for the queue.
- later() : mixed
- Push a new job onto the queue after a delay.
- laterOn() : mixed
- Push a new job onto the queue after a delay.
- pop() : Job|null
- Pop the next job off of the queue.
- push() : mixed
- Push a new job onto the queue.
- pushOn() : mixed
- Push a new job onto the queue.
- pushRaw() : mixed
- Push a raw payload onto the queue.
- setConnectionName() : $this
- Set the connection name for the queue.
- size() : int
- Get the size of the queue.
Methods
bulk()
Push an array of jobs onto the queue.
public
bulk(array<string|int, mixed> $jobs[, mixed $data = '' ][, string $queue = null ]) : mixed
Parameters
- $jobs : array<string|int, mixed>
- $data : mixed = ''
- $queue : string = null
Return values
mixed —getConnectionName()
Get the connection name for the queue.
public
getConnectionName() : string
Return values
string —later()
Push a new job onto the queue after a delay.
public
later(DateTimeInterface|DateInterval|int $delay, string|object $job[, mixed $data = '' ][, string $queue = null ]) : mixed
Parameters
- $delay : DateTimeInterface|DateInterval|int
- $job : string|object
- $data : mixed = ''
- $queue : string = null
Return values
mixed —laterOn()
Push a new job onto the queue after a delay.
public
laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|object $job[, mixed $data = '' ]) : mixed
Parameters
- $queue : string
- $delay : DateTimeInterface|DateInterval|int
- $job : string|object
- $data : mixed = ''
Return values
mixed —pop()
Pop the next job off of the queue.
public
pop([string $queue = null ]) : Job|null
Parameters
- $queue : string = null
Return values
Job|null —push()
Push a new job onto the queue.
public
push(string|object $job[, mixed $data = '' ][, string $queue = null ]) : mixed
Parameters
- $job : string|object
- $data : mixed = ''
- $queue : string = null
Return values
mixed —pushOn()
Push a new job onto the queue.
public
pushOn(string $queue, string|object $job[, mixed $data = '' ]) : mixed
Parameters
- $queue : string
- $job : string|object
- $data : mixed = ''
Return values
mixed —pushRaw()
Push a raw payload onto the queue.
public
pushRaw(string $payload[, string $queue = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $payload : string
- $queue : string = null
- $options : array<string|int, mixed> = []
Return values
mixed —setConnectionName()
Set the connection name for the queue.
public
setConnectionName(string $name) : $this
Parameters
- $name : string
Return values
$this —size()
Get the size of the queue.
public
size([string $queue = null ]) : int
Parameters
- $queue : string = null