ILIAS
Release_5_0_x_branch Revision 61816
|
Cron management. More...
Static Public Member Functions | |
static | runActiveJobs () |
Run all active jobs. | |
static | runJobManual ($a_job_id) |
Run single job manually. | |
static | getJobInstanceById ($a_job_id) |
Get job instance (by job id) | |
static | getJobInstance ($a_id, $a_component, $a_class, $a_path=null) |
Get job instance (by job data) | |
static | createDefaultEntry (ilCronJob $a_job, $a_component, $a_class, $a_path) |
static | updateFromXML ($a_component, $a_id, $a_class, $a_path=null) |
Process data from module.xml/service.xml. | |
static | clearFromXML ($a_component, array $a_xml_job_ids) |
Clear job data. | |
static | getPluginJobs ($a_only_active=false) |
static | getCronJobData ($a_id=null, $a_include_inactive=true) |
Get cron job configuration/execution data. | |
static | resetJob (ilCronJob $a_job) |
Reset job. | |
static | activateJob (ilCronJob $a_job, $a_manual=false) |
Activate cron job. | |
static | deactivateJob (ilCronJob $a_job, $a_manual=false) |
Deactivate cron job. | |
static | isJobActive ($a_job_id) |
Check if given job is currently active. | |
static | isJobInactive ($a_job_id) |
Check if given job is currently inactive. | |
static | updateJobSchedule (ilCronJob $a_job, $a_schedule_type, $a_schedule_value) |
Update job schedule. | |
static | ping ($a_job_id) |
Keep cron job alive. |
Static Protected Member Functions | |
static | runJob (ilCronJob $a_job, array $a_job_data, $a_manual=false) |
Run single cron job (internal) | |
static | sendNotification (ilCronJob $a_job, $a_message) |
Send notification to admin about job event(s) | |
static | updateJobResult (ilCronJob $a_job, ilCronJobResult $a_result, $a_manual=false) |
Save job result. | |
static | getMicrotime () |
Get current microtime. |
Cron management.
Definition at line 11 of file class.ilCronManager.php.
|
static |
Activate cron job.
ilCronJob | $a_job | |
bool | $a_manual |
Definition at line 573 of file class.ilCronManager.php.
References $ilDB, $ilUser, ilCronJob\activationWasToggled(), and ilCronJob\getId().
Referenced by ilCronManagerGUI\confirmedActivate(), createDefaultEntry(), and resetJob().
|
static |
Clear job data.
string | $a_component | |
array | $a_xml_job_ids |
Definition at line 413 of file class.ilCronManager.php.
References $ilDB, $ilLog, and $row.
Referenced by ilObjDefReader\handlerEndTag().
|
static |
Definition at line 320 of file class.ilCronManager.php.
References $ilDB, $ilLog, $ilSetting, $row, activateJob(), ilCronJob\activationWasToggled(), ilCronJob\getDefaultScheduleType(), ilCronJob\getDefaultScheduleValue(), ilCronJob\getId(), ilCronJob\hasAutoActivation(), ilCronJob\hasFlexibleSchedule(), and updateJobSchedule().
Referenced by getJobInstanceById(), getPluginJobs(), and updateFromXML().
|
static |
Deactivate cron job.
ilCronJob | $a_job | |
bool | $a_manual |
Definition at line 596 of file class.ilCronManager.php.
References $ilDB, $ilUser, ilCronJob\activationWasToggled(), and ilCronJob\getId().
Referenced by ilCronManagerGUI\confirmedDeactivate(), and runJob().
|
static |
Get cron job configuration/execution data.
array | string | $a_id | |
array | $a_include_inactive |
Definition at line 499 of file class.ilCronManager.php.
References $ilDB, $res, $row, and IL_COMP_PLUGIN.
Referenced by ilCronManagerGUI\addToExternalSettingsForm(), ilCronDeleteInactiveUserAccounts\calculateDeletionData(), ilCronManagerTableGUI\getItems(), getJobInstanceById(), getPluginJobs(), ilCronManagerGUI\initEditForm(), isJobActive(), and isJobInactive().
|
static |
Get job instance (by job data)
string | $a_component | |
string | $a_class | |
string | $a_path |
Definition at line 264 of file class.ilCronManager.php.
References $ilLog.
Referenced by ilCronManagerGUI\addToExternalSettingsForm(), ilCronManagerTableGUI\getItems(), getJobInstanceById(), and updateFromXML().
|
static |
Get job instance (by job id)
string | $a_job_id |
Definition at line 213 of file class.ilCronManager.php.
References $ilLog, createDefaultEntry(), getCronJobData(), getJobInstance(), IL_COMP_PLUGIN, and IL_COMP_SERVICE.
Referenced by ilCronManagerGUI\confirmedReset(), ilCronManagerGUI\getMultiActionData(), ilCronManagerGUI\initEditForm(), runActiveJobs(), runJobManual(), and ilCronManagerGUI\update().
|
staticprotected |
Get current microtime.
Definition at line 698 of file class.ilCronManager.php.
Referenced by runJob().
|
static |
Definition at line 460 of file class.ilCronManager.php.
References $res, createDefaultEntry(), getCronJobData(), IL_COMP_PLUGIN, and IL_COMP_SERVICE.
Referenced by ilCronManagerTableGUI\getItems().
|
static |
Check if given job is currently active.
string | $a_job_id |
Definition at line 619 of file class.ilCronManager.php.
References getCronJobData().
Referenced by ilCronManagerGUI\confirmedDeactivate(), ilObjForumAdministrationGUI\getSettingsForm(), ilObjContentObjectGUI\linkChecker(), and ilLPObjectStatisticsGUI\showCronJobInfo().
|
static |
Check if given job is currently inactive.
string | $a_job_id |
Definition at line 635 of file class.ilCronManager.php.
References getCronJobData().
Referenced by ilCronManagerGUI\confirmedActivate().
|
static |
Keep cron job alive.
string | $a_job_id |
Definition at line 709 of file class.ilCronManager.php.
References $ilDB.
Referenced by ilLPCronObjectStatistics\gatherCourseLPData(), ilLPCronObjectStatistics\gatherTypesData(), ilLPCronObjectStatistics\gatherUserData(), and ilMembershipCronNotifications\run().
|
static |
Reset job.
ilCronJob | $a_job |
Definition at line 547 of file class.ilCronManager.php.
References $ilDB, $result, activateJob(), ilCronJob\getId(), ilCronJobResult\STATUS_RESET, and updateJobResult().
Referenced by ilCronManagerGUI\confirmedActivate(), and ilCronManagerGUI\confirmedReset().
|
static |
Run all active jobs.
Definition at line 16 of file class.ilCronManager.php.
References $ilLog, $ilSetting, $row, ilUtil\_getHttpPath(), getJobInstanceById(), and runJob().
|
staticprotected |
Run single cron job (internal)
ilCronJob | $a_job | |
array | $a_job_data | |
bool | $a_manual |
Definition at line 97 of file class.ilCronManager.php.
References $ilDB, $ilLog, $result, deactivateJob(), getMicrotime(), ilCronJob\isActive(), ilCronJob\run(), sendNotification(), ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_INVALID_CONFIGURATION, and updateJobResult().
Referenced by runActiveJobs(), and runJobManual().
|
static |
Run single job manually.
string | $a_job_id |
Definition at line 58 of file class.ilCronManager.php.
References $ilLog, $result, getJobInstanceById(), and runJob().
Referenced by ilCronManagerGUI\confirmedRun().
|
staticprotected |
Send notification to admin about job event(s)
ilCronJob | $a_job | |
string | $a_message |
Definition at line 315 of file class.ilCronManager.php.
Referenced by runJob().
|
static |
Process data from module.xml/service.xml.
string | $a_component | |
string | $a_id | |
string | $a_class | |
string | $_path |
Definition at line 390 of file class.ilCronManager.php.
References $ilDB, createDefaultEntry(), and getJobInstance().
Referenced by ilObjDefReader\handlerBeginTag().
|
staticprotected |
Save job result.
ilCronJob | $a_job | |
ilCronJobResult | $a_result | |
bool | $a_manual |
Definition at line 652 of file class.ilCronManager.php.
References $ilDB, $ilUser, ilCronJobResult\getCode(), ilCronJobResult\getDuration(), ilCronJob\getId(), ilCronJobResult\getMessage(), and ilCronJobResult\getStatus().
Referenced by resetJob(), and runJob().
|
static |
Update job schedule.
ilCronJob | $a_job | |
int | $a_schedule_type | |
int | $a_schedule_value |
Definition at line 677 of file class.ilCronManager.php.
References $ilDB, ilCronJob\getId(), ilCronJob\getValidScheduleTypes(), and ilCronJob\hasFlexibleSchedule().
Referenced by createDefaultEntry(), ilCronManagerTableGUI\parseJobToData(), and ilCronManagerGUI\update().