RecurringJobInterface
interface RecurringJobInterface implements JobInterface
Job recurring interface
Methods
string|null
getRecurringInterval()
Return recurring interval
void
setRecurringInterval(string $interval)
Set recurring interval
integer
getDueDate()
Get next run date time timestamp
bool
isDue()
Return true if job is due
Details
in JobInterface at line 30
void
setDateExecuted(int|null $time)
Set execution date
in JobInterface at line 38
void
setDateCreated(int|null $time)
Set date pushed in queue
in JobInterface at line 45
int|null
getDateExecuted()
Get execution timestamp
in JobInterface at line 52
int|null
getDateCreated()
Get date created timestamp
in JobInterface at line 60
void
addError(string $errorMessage)
Add error
in JobInterface at line 67
bool
hasSuccess()
Return true if job is executed successful
in JobInterface at line 74
array
getErrors()
Get execution errors
in JobInterface at line 81
string|null
getId()
Return unique job id
in JobInterface at line 89
void
setId(string|null $id)
Set id
in JobInterface at line 97
void
setStatus(int $status)
Set job status
in JobInterface at line 104
int
getStatus()
Get job status
in JobInterface at line 111
int
getPriority()
Return job priority
in JobInterface at line 119
void
setPriority(int $priority)
Set priority
in JobInterface at line 126
string|null
getName()
Return job name
in JobInterface at line 134
void
setName(string|null $name)
Set name
in JobInterface at line 141
void
execute()
Job code
in JobInterface at line 148
string|null
getExtensionName()
Return extension name
in JobInterface at line 156
void
setExtensionName(string|null $name)
Set extension name
in JobInterface at line 164
void
setQueue(string|null $name)
Set executuion Queue (null for any)
in JobInterface at line 171
string|null
getQueue()
Get queue
in JobInterface at line 178
array
toArray()
Convert to array
at line 24
string|null
getRecurringInterval()
Return recurring interval
at line 32
void
setRecurringInterval(string $interval)
Set recurring interval
at line 39
integer
getDueDate()
Get next run date time timestamp
at line 46
bool
isDue()
Return true if job is due