ScheduledJob
abstract class ScheduledJob extends Job implements ScheduledJobInterface, JobInterface
Base class for all scheduled jobs
Properties
protected string|integer|null | $id | Unique job id | from Job |
protected string|null | $name | Job name | from Job |
protected integer | $priority | Priority | from Job |
protected string|null | $extension | Extension name | from Job |
protected int | $status | Job status | from Job |
protected array | $errors | Execution errors | from Job |
protected int|null | $dateExecuted | Execution timestamp | from Job |
protected int|null | $dateCreated | Date added to queue | from Job |
protected string|null | $queue | Queue name | from Job |
protected array | $params | Job params | from Job |
protected integer | $scheduleTime | Scheduled date time (timestamp) |
Methods
Constructor
Convert to array
ScheduledJobInterface implementation
Set scheduled time (timestamp)
Set scheduled time
Return true if job is due
Details
in Job at line 95
abstract void
execute()
Job code
at line 36
__construct(string|null $extension, string|null $name = null, array $params = [])
Constructor
in Job at line 125
void
setParam(string $name, mixed $value)
Set param
in Job at line 137
mixed
getParam(string $name, mixed $default = null)
Get param value
in Job at line 147
void
init()
Init job
at line 48
array
toArray()
Convert to array
in Job at line 177
array
getErrors()
Get execution errors
in Job at line 188
void
addError(string $errorMessage)
Add error
in Job at line 198
bool
hasSuccess()
Return true if job is executed successful
in Job at line 208
int|null
getDateExecuted()
Get execution timestamp
in Job at line 218
int|null
getDateCreated()
Get date created
in Job at line 229
void
setDateExecuted(int|null $time)
Set execution date
in Job at line 240
void
setDateCreated(int|null $time)
Set date pused to queue
in Job at line 250
int
getStatus()
Get job status
in Job at line 261
void
setStatus(int $status)
Set job status
in Job at line 275
void
__set(string $name, mixed $value)
Set
in Job at line 286
void
setId(string|null $id)
Set id
in Job at line 296
string|null
getId()
Get id
in Job at line 306
string|null
getExtensionName()
Get extension name
in Job at line 316
string|null
getName()
Get name
in Job at line 326
int
getPriority()
Get priority
in Job at line 337
void
setName(string|null $name)
Set name
in Job at line 348
void
setPriority(int $priority)
Set priority
in Job at line 359
void
setExtensionName(string|null $name)
Set extension name
in Job at line 370
void
setQueue(string|null $name)
Set executuion Queue (null for any)
in Job at line 380
string|null
getQueue()
Get queue
at line 61
int
getScheduleTime()
ScheduledJobInterface implementation
at line 72
mixed
setScheduleTime(int $timestamp)
Set scheduled time (timestamp)
at line 85
ScheduledJob
runAt(string $date)
Set scheduled time
at line 95
bool
isDue()
Return true if job is due