InteractsWithQueue
trait InteractsWithQueue (View source)
Traits
Properties
| Job|null | $job | The underlying queue job instance. |
Methods
Get the number of seconds until the given DateTime.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Get the number of times the job has been attempted.
Delete the job from the queue.
Release the job back into the queue after (n) seconds.
Indicate that queue interactions like fail, delete, and release should be faked.
Assert that the job was deleted from the queue.
Assert that the job was manually failed.
Assert that the job was released back onto the queue.
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.
protected string
runTimeForHumans(float $startTime, float $endTime = null)
Given a start time, format the total run time for human readability.
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
withFakeQueueInteractions()
Indicate that queue interactions like fail, delete, and release should be faked.
$this
assertDeleted()
Assert that the job was deleted from the queue.
$this
assertFailed()
Assert that the job was manually failed.
$this
assertReleased(DateTimeInterface|DateInterval|int $delay = null)
Assert that the job was released back onto the queue.
$this
setJob(Job $job)
Set the base queue job instance.