Documentation

DatabaseJobRecord
in package
Uses InteractsWithTime

Table of Contents

$record  : stdClass
The underlying job record.
__construct()  : void
Create a new job record instance.
__get()  : mixed
Dynamically access the underlying job information.
increment()  : int
Increment the number of times the job has been attempted.
touch()  : int
Update the "reserved at" timestamp of the job.
availableAt()  : int
Get the "available at" UNIX timestamp.
currentTime()  : int
Get the current system time as a UNIX timestamp.
parseDateInterval()  : DateTimeInterface|int
If the given value is an interval, convert it to a DateTime instance.
secondsUntil()  : int
Get the number of seconds until the given DateTime.

Properties

Methods

__construct()

Create a new job record instance.

public __construct(stdClass $record) : void
Parameters
$record : stdClass
Return values
void

__get()

Dynamically access the underlying job information.

public __get(string $key) : mixed
Parameters
$key : string
Return values
mixed

increment()

Increment the number of times the job has been attempted.

public increment() : int
Return values
int

touch()

Update the "reserved at" timestamp of the job.

public touch() : int
Return values
int

availableAt()

Get the "available at" UNIX timestamp.

protected availableAt(DateTimeInterface|DateInterval|int $delay) : int
Parameters
$delay : DateTimeInterface|DateInterval|int
Return values
int

currentTime()

Get the current system time as a UNIX timestamp.

protected currentTime() : int
Return values
int

parseDateInterval()

If the given value is an interval, convert it to a DateTime instance.

protected parseDateInterval(DateTimeInterface|DateInterval|int $delay) : DateTimeInterface|int
Parameters
$delay : DateTimeInterface|DateInterval|int
Return values
DateTimeInterface|int

secondsUntil()

Get the number of seconds until the given DateTime.

protected secondsUntil(DateTimeInterface|DateInterval|int $delay) : int
Parameters
$delay : DateTimeInterface|DateInterval|int
Return values
int

Search results