Janitor
Allows an app to program tasks to be executed periodically.
JANITORTASK_EXECUTION_RETURN_CRITICAL
Return code for JanitorTask run when task returned a critical error.JANITORTASK_EXECUTION_RETURN_OK
Return code for JanitorTask run when task was executed without errors.
JANITORTASK_EXECUTION_PERIODICITY_ONLY_MANUAL
The task can only be executed when calling the Janitor run process with an specific task parameter. It won't be executed on regular "all-tasks" calls to Janitor.JANITORTASK_EXECUTION_PERIODICITY_ALWAYS
The task must be executed every time Janitor run is called.JANITORTASK_EXECUTION_PERIODICITY_EACH_SECONDS
The task must be executed every specified seconds. Seconds specified inperiodicityEachSeconds
config key.JANITORTASK_EXECUTION_PERIODICITY_MINUTES
The task must be executed on the given minutes of each hour. Desired minutes are specified as an array in theperiodicityMinutes
config key with the syntax:[0, 15, 30, 45]
JANITORTASK_EXECUTION_PERIODICITY_HOURS
The task must be executed on the given hours of each day. Desired hours/minute are specified as an array in theperiodicityHours
config key with the syntax:["hour:minute", "hour:minute", "hour:minute"]
JANITORTASK_EXECUTION_PERIODICITY_DAYSOFMONTH
The task must be executed on the given days of each month. Desired days/hour/minute are specified as an array in theperiodicityDaysOfMonth
config key with the syntax:["[email protected]:minute", "[email protected]:minute", "[email protected]:minute"]
(Take into account days of month that do not exist)
logDatabaseProviderName
The name of the DatabaseProvider to use for storing Janitor log. Defaults tomain
.logTableName
The name of the table used to store Janitor log. Defaults tocherrycake_janitor_log
coreJanitorTasks
An array of names of the Cherrycake core JanitorTask classes to run. Defaults to an array with the following elements:JanitorTaskJanitorPurge
JanitorTaskSystemLogPurge
JanitorTaskSystemLogCommit
JanitorTaskSessionPurge
JanitorTaskStatsCommit
JanitorTaskLogCommit
appJanitorTasks
An array of names of App JanitorTask classes to run.
Last modified 2yr ago