Queue
interface Queue (View source)
Methods
| int | size(string|null $queue = null) Get the size of the queue. |
|
| mixed | push(string|object $job, mixed $data = '', string|null $queue = null) Push a new job onto the queue. |
|
| mixed | pushOn(string $queue, string|object $job, mixed $data = '') Push a new job onto the queue. |
|
| mixed | pushRaw(string $payload, string|null $queue = null, array $options = []) Push a raw payload onto the queue. |
|
| mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null) Push a new job onto the queue after (n) seconds. |
|
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '') Push a new job onto a specific queue after (n) seconds. |
|
| mixed | bulk(array $jobs, mixed $data = '', string|null $queue = null) Push an array of jobs onto the queue. |
|
| Job|null | pop(string|null $queue = null) Pop the next job off of the queue. |
|
| string | getConnectionName() Get the connection name for the queue. |
|
| $this | setConnectionName(string $name) Set the connection name for the queue. |
Details
int size(string|null $queue = null)
Get the size of the queue.
mixed push(string|object $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue.
mixed pushOn(string $queue, string|object $job, mixed $data = '')
Push a new job onto the queue.
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])
Push a raw payload onto the queue.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue after (n) seconds.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
mixed bulk(array $jobs, mixed $data = '', string|null $queue = null)
Push an array of jobs onto the queue.
Job|null pop(string|null $queue = null)
Pop the next job off of the queue.
string getConnectionName()
Get the connection name for the queue.
$this setConnectionName(string $name)
Set the connection name for the queue.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Contracts/Queue/Queue.html