CronClass
in package
Defines global attributes and methods for all classes.
Tags
Table of Contents
- $dataBase : DataBase
- Database object.
- $init : int
- $pluginName : string
- __construct() : mixed
- CronClass constructor.
- isTimeForJob() : bool
- Returns true if this cron job can be executed (never executed or more than period), false otherwise.
- jobDone() : mixed
- Updates when this job is executed.
- run() : mixed
- Select and execute the relevant controller for the cron.
- toolBox() : ToolBox
Properties
$dataBase
Database object.
protected
DataBase
$dataBase
$init
private
int
$init
$pluginName
private
string
$pluginName
Methods
__construct()
CronClass constructor.
public
__construct(string $pluginName) : mixed
Parameters
- $pluginName : string
Return values
mixed —isTimeForJob()
Returns true if this cron job can be executed (never executed or more than period), false otherwise.
public
isTimeForJob(string $jobName[, string $period = '1 day' ]) : bool
Parameters
- $jobName : string
- $period : string = '1 day'
Return values
bool —jobDone()
Updates when this job is executed.
public
jobDone(string $jobName) : mixed
Parameters
- $jobName : string
Return values
mixed —run()
Select and execute the relevant controller for the cron.
public
abstract run() : mixed
Return values
mixed —toolBox()
protected
toolBox() : ToolBox