TimedJob
extends Job
in package
Simple base class to extend to run periodic background jobs.
Call setInterval with your desired interval in seconds from the constructor.
Tags
Table of Contents
Properties
- $allowParallelRuns : bool
- $argument : mixed
- $id : string
- $interval : int
- $lastRun : int
- $time : ITimeFactory
- $timeSensitivity : int
Methods
- __construct() : mixed
- getAllowParallelRuns() : bool
- getArgument() : mixed
- Get the argument associated with the background job This is the argument that will be passed to the background job
- getId() : string
- Get the id of the background job This id is determined by the job list when a job is added to the list
- getInterval() : int
- Get the interval [seconds] for the job
- getLastRun() : int
- Get the last time this job was run as unix timestamp
- isTimeSensitive() : bool
- Whether the background job is time sensitive and needs to run soon after the scheduled interval, of if it is okay to be delayed until a later time.
- setAllowParallelRuns() : void
- Set this to false to prevent two Jobs from the same class from running in parallel
- setArgument() : void
- setId() : void
- setInterval() : void
- Set the interval for the job
- setLastRun() : void
- setTimeSensitivity() : void
- If your background job is not time sensitive (sending instant email notifications, etc.) it would be nice to set it to IJob::TIME_INSENSITIVE This way the execution can be delayed during high usage times.
- start() : void
- Run the job if the last run is more than the interval ago
- run() : mixed
Properties
$allowParallelRuns
protected
bool
$allowParallelRuns
= true
$argument
protected
mixed
$argument
= null
$id
protected
string
$id
= '0'
$interval
protected
int
$interval
= 0
$lastRun
protected
int
$lastRun
= 0
$time
protected
ITimeFactory
$time
$timeSensitivity
protected
int
$timeSensitivity
= \OCP\BackgroundJob\IJob::TIME_SENSITIVE
Methods
__construct()
public
__construct(ITimeFactory $time) : mixed
Parameters
- $time : ITimeFactory
Tags
getAllowParallelRuns()
public
getAllowParallelRuns() : bool
Attributes
- #[Override]
Return values
boolgetArgument()
Get the argument associated with the background job This is the argument that will be passed to the background job
public
getArgument() : mixed
Attributes
- #[Override]
getId()
Get the id of the background job This id is determined by the job list when a job is added to the list
public
final getId() : string
Attributes
- #[Override]
Return values
stringgetInterval()
Get the interval [seconds] for the job
public
getInterval() : int
Tags
Return values
intgetLastRun()
Get the last time this job was run as unix timestamp
public
final getLastRun() : int
Attributes
- #[Override]
Return values
intisTimeSensitive()
Whether the background job is time sensitive and needs to run soon after the scheduled interval, of if it is okay to be delayed until a later time.
public
isTimeSensitive() : bool
Tags
Return values
boolsetAllowParallelRuns()
Set this to false to prevent two Jobs from the same class from running in parallel
public
setAllowParallelRuns(bool $allow) : void
Parameters
- $allow : bool
Attributes
- #[Override]
setArgument()
public
setArgument(mixed $argument) : void
Parameters
- $argument : mixed
Attributes
- #[Override]
setId()
public
final setId(string $id) : void
Parameters
- $id : string
Attributes
- #[Override]
setInterval()
Set the interval for the job
public
setInterval(int $seconds) : void
Parameters
- $seconds : int
-
the time to pass between two runs of the same job in seconds
Tags
setLastRun()
public
final setLastRun(int $lastRun) : void
Parameters
- $lastRun : int
Attributes
- #[Override]
setTimeSensitivity()
If your background job is not time sensitive (sending instant email notifications, etc.) it would be nice to set it to IJob::TIME_INSENSITIVE This way the execution can be delayed during high usage times.
public
setTimeSensitivity(int $sensitivity) : void
Parameters
- $sensitivity : int
Tags
start()
Run the job if the last run is more than the interval ago
public
final start(IJobList $jobList) : void
Parameters
- $jobList : IJobList
-
The job list that manages the state of this job
Tags
run()
protected
abstract run(mixed $argument) : mixed
Parameters
- $argument : mixed