InteractsWithQueue
trait InteractsWithQueue (View source)
Traits
Properties
| Job|null | $job | The underlying queue job instance. |
Methods
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Get the number of seconds until the given DateTime. |
from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Get the "available at" UNIX timestamp. |
from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) If the given value is an interval, convert it to a DateTime instance. |
from InteractsWithTime |
| int | currentTime() Get the current system time as a UNIX timestamp. |
from InteractsWithTime |
| int | attempts() Get the number of times the job has been attempted. |
|
| void | delete() Delete the job from the queue. |
|
| void | fail(Throwable|string|null $exception = null) Fail the job from the queue. |
|
| void | release(DateTimeInterface|DateInterval|int $delay = 0) Release the job back into the queue after (n) seconds. |
|
| $this | setJob(Job $job) Set the base queue job instance. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int currentTime()
Get the current system time as a UNIX timestamp.
int attempts()
Get the number of times the job has been attempted.
void delete()
Delete the job from the queue.
void fail(Throwable|string|null $exception = null)
Fail the job from the queue.
void release(DateTimeInterface|DateInterval|int $delay = 0)
Release the job back into the queue after (n) seconds.
$this setJob(Job $job)
Set the base queue job instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/InteractsWithQueue.html