ILIAS
release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
|
Cron job application base class. More...
Public Member Functions | |
isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false) | |
Is job currently active? More... | |
getScheduleType () | |
Get current schedule type (if flexible) More... | |
getScheduleValue () | |
Get current schedule value (if flexible) More... | |
setSchedule ($a_type, $a_value) | |
Update current schedule (if flexible) More... | |
getValidScheduleTypes () | |
Get all available schedule types. More... | |
getTitle () | |
Get title. More... | |
getDescription () | |
Get description. More... | |
isManuallyExecutable () | |
Defines whether or not a cron job can be started manually. More... | |
hasCustomSettings () | |
Has cron job any custom setting which can be edited? More... | |
addCustomSettingsToForm (ilPropertyFormGUI $a_form) | |
Add custom settings to form. More... | |
saveCustomSettings (ilPropertyFormGUI $a_form) | |
Save custom settings. More... | |
addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active) | |
Add external settings to form. More... | |
activationWasToggled ($a_currently_active) | |
Cron job status was changed. More... | |
getId () | |
Get id. More... | |
hasAutoActivation () | |
Is to be activated on "installation". More... | |
hasFlexibleSchedule () | |
Can the schedule be configured? More... | |
getDefaultScheduleType () | |
Get schedule type. More... | |
getDefaultScheduleValue () | |
Get schedule value. More... | |
run () | |
Run job. More... | |
Data Fields | |
const | SCHEDULE_TYPE_DAILY = 1 |
const | SCHEDULE_TYPE_IN_MINUTES = 2 |
const | SCHEDULE_TYPE_IN_HOURS = 3 |
const | SCHEDULE_TYPE_IN_DAYS = 4 |
const | SCHEDULE_TYPE_WEEKLY = 5 |
const | SCHEDULE_TYPE_MONTHLY = 6 |
const | SCHEDULE_TYPE_QUARTERLY = 7 |
const | SCHEDULE_TYPE_YEARLY = 8 |
Protected Member Functions | |
checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value) | |
Cron job application base class.
Definition at line 11 of file class.ilCronJob.php.
ilCronJob::activationWasToggled | ( | $a_currently_active | ) |
Cron job status was changed.
bool | $a_currently_active |
Reimplemented in ilForumCronNotification, ilWebResourceCronLinkCheck, ilMailCronNotification, ilMembershipCronNotifications, ilPaymentCronNotification, and ilDAVCronDiskQuota.
Definition at line 259 of file class.ilCronJob.php.
Referenced by ilCronManager\activateJob(), ilCronManager\createDefaultEntry(), and ilCronManager\deactivateJob().
ilCronJob::addCustomSettingsToForm | ( | ilPropertyFormGUI | $a_form | ) |
Add custom settings to form.
ilPropertyFormGUI | $a_form |
Reimplemented in ilConsultationHourCron, ilMailCronNotification, ilMailCronOrphanedMails, ilPaymentCronNotification, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilDAVCronDiskQuota, and ilSCCronTrash.
Definition at line 221 of file class.ilCronJob.php.
ilCronJob::addToExternalSettingsForm | ( | $a_form_id, | |
array & | $a_fields, | ||
$a_is_active | |||
) |
Add external settings to form.
int | $a_form_id | |
array | $a_fields | |
bool | $a_is_active |
Reimplemented in ilLDAPCronSynchronization, ilMembershipCronNotifications, and ilDAVCronDiskQuota.
Definition at line 244 of file class.ilCronJob.php.
|
protected |
Definition at line 114 of file class.ilCronJob.php.
References SCHEDULE_TYPE_DAILY, SCHEDULE_TYPE_IN_DAYS, SCHEDULE_TYPE_IN_HOURS, SCHEDULE_TYPE_IN_MINUTES, SCHEDULE_TYPE_MONTHLY, SCHEDULE_TYPE_QUARTERLY, SCHEDULE_TYPE_WEEKLY, and SCHEDULE_TYPE_YEARLY.
Referenced by isActive().
|
abstract |
Get schedule type.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\createDefaultEntry(), isActive(), and ilCronManagerTableGUI\parseJobToData().
|
abstract |
Get schedule value.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\createDefaultEntry(), isActive(), and ilCronManagerTableGUI\parseJobToData().
ilCronJob::getDescription | ( | ) |
Get description.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Definition at line 188 of file class.ilCronJob.php.
Referenced by ilCronManagerTableGUI\parseJobToData().
|
abstract |
Get id.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\activateJob(), ilCronManager\createDefaultEntry(), ilCronManager\deactivateJob(), ilCronManager\resetJob(), ilCronManager\runJob(), ilCronManager\updateJobResult(), and ilCronManager\updateJobSchedule().
ilCronJob::getScheduleType | ( | ) |
Get current schedule type (if flexible)
Definition at line 54 of file class.ilCronJob.php.
References hasFlexibleSchedule().
Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod().
ilCronJob::getScheduleValue | ( | ) |
Get current schedule value (if flexible)
Definition at line 67 of file class.ilCronJob.php.
References hasFlexibleSchedule().
ilCronJob::getTitle | ( | ) |
Get title.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Definition at line 178 of file class.ilCronJob.php.
Referenced by ilCronManagerTableGUI\parseJobToData().
ilCronJob::getValidScheduleTypes | ( | ) |
Get all available schedule types.
Reimplemented in ilSCCronTrash.
Definition at line 98 of file class.ilCronJob.php.
Referenced by setSchedule(), and ilCronManager\updateJobSchedule().
|
abstract |
Is to be activated on "installation".
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\createDefaultEntry().
ilCronJob::hasCustomSettings | ( | ) |
Has cron job any custom setting which can be edited?
Reimplemented in ilForumCronNotification, ilConsultationHourCron, ilMailCronNotification, ilMailCronOrphanedMails, ilPaymentCronNotification, ilSCCronTrash, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, and ilDAVCronDiskQuota.
Definition at line 211 of file class.ilCronJob.php.
Referenced by ilCronManagerTableGUI\parseJobToData().
|
abstract |
Can the schedule be configured?
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\createDefaultEntry(), getScheduleType(), getScheduleValue(), isActive(), ilCronManagerTableGUI\parseJobToData(), setSchedule(), and ilCronManager\updateJobSchedule().
ilCronJob::isActive | ( | $a_ts_last_run, | |
$a_schedule_type, | |||
$a_schedule_value, | |||
$a_manual = false |
|||
) |
Is job currently active?
timestamp | $a_ts_last_run | |
integer | $a_ts_last_run | |
integer | $a_ts_last_run | |
bool | $a_ts_last_run |
Definition at line 35 of file class.ilCronJob.php.
References checkSchedule(), getDefaultScheduleType(), getDefaultScheduleValue(), and hasFlexibleSchedule().
Referenced by ilCronManager\runJob().
ilCronJob::isManuallyExecutable | ( | ) |
Defines whether or not a cron job can be started manually.
Definition at line 197 of file class.ilCronJob.php.
Referenced by ilCronManagerTableGUI\parseJobToData().
|
abstract |
Run job.
Reimplemented in ilExcCronFeedbackNotification, ilForumCronNotification, ilLearningModuleCronLinkCheck, ilSurveyCronNotification, ilWebResourceCronLinkCheck, ilConsultationHourCron, ilLDAPCronSynchronization, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilPaymentCronNotification, ilLuceneIndexer, ilSCCronTrash, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilUserCronCheckAccounts, and ilDAVCronDiskQuota.
Referenced by ilCronManager\runJob().
ilCronJob::saveCustomSettings | ( | ilPropertyFormGUI | $a_form | ) |
Save custom settings.
ilPropertyFormGUI | $a_form |
Reimplemented in ilForumCronNotification, ilConsultationHourCron, ilMailCronNotification, ilMailCronOrphanedMails, ilPaymentCronNotification, ilSCCronTrash, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, and ilDAVCronDiskQuota.
Definition at line 232 of file class.ilCronJob.php.
ilCronJob::setSchedule | ( | $a_type, | |
$a_value | |||
) |
Update current schedule (if flexible)
integer | $a_type | |
integer | $a_value |
Definition at line 82 of file class.ilCronJob.php.
References getValidScheduleTypes(), and hasFlexibleSchedule().
const ilCronJob::SCHEDULE_TYPE_DAILY = 1 |
Definition at line 13 of file class.ilCronJob.php.
Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod(), checkSchedule(), ilExcCronFeedbackNotification\getDefaultScheduleType(), ilLearningModuleCronLinkCheck\getDefaultScheduleType(), ilSurveyCronNotification\getDefaultScheduleType(), ilWebResourceCronLinkCheck\getDefaultScheduleType(), ilConsultationHourCron\getDefaultScheduleType(), ilLDAPCronSynchronization\getDefaultScheduleType(), ilMailCronNotification\getDefaultScheduleType(), ilMailCronOrphanedMails\getDefaultScheduleType(), ilMembershipCronMinMembers\getDefaultScheduleType(), ilMembershipCronNotifications\getDefaultScheduleType(), ilPaymentCronNotification\getDefaultScheduleType(), ilLuceneIndexer\getDefaultScheduleType(), ilLPCronObjectStatistics\getDefaultScheduleType(), ilCronDeleteInactivatedUserAccounts\getDefaultScheduleType(), ilCronDeleteInactiveUserAccounts\getDefaultScheduleType(), ilUserCronCheckAccounts\getDefaultScheduleType(), ilDAVCronDiskQuota\getDefaultScheduleType(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), and ilCronManagerTableGUI\parseJobToData().
const ilCronJob::SCHEDULE_TYPE_IN_DAYS = 4 |
Definition at line 16 of file class.ilCronJob.php.
Referenced by checkSchedule(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), ilCronDeleteInactiveUserAccounts\saveCustomSettings(), and ilCronManagerGUI\update().
const ilCronJob::SCHEDULE_TYPE_IN_HOURS = 3 |
const ilCronJob::SCHEDULE_TYPE_IN_MINUTES = 2 |
Definition at line 14 of file class.ilCronJob.php.
Referenced by checkSchedule(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), and ilCronManagerGUI\update().
const ilCronJob::SCHEDULE_TYPE_MONTHLY = 6 |
Definition at line 18 of file class.ilCronJob.php.
Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod(), checkSchedule(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().
const ilCronJob::SCHEDULE_TYPE_QUARTERLY = 7 |
Definition at line 19 of file class.ilCronJob.php.
Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod(), checkSchedule(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().
const ilCronJob::SCHEDULE_TYPE_WEEKLY = 5 |
Definition at line 17 of file class.ilCronJob.php.
Referenced by ilWebResourceCronLinkCheck\__getCheckPeriod(), checkSchedule(), ilSCCronTrash\getDefaultScheduleType(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().
const ilCronJob::SCHEDULE_TYPE_YEARLY = 8 |
Definition at line 20 of file class.ilCronJob.php.
Referenced by checkSchedule(), ilCronDeleteInactiveUserAccounts\getTimeDifferenceBySchedule(), ilCronManagerGUI\initEditForm(), ilCronManagerTableGUI\parseJobToData(), and ilCronDeleteInactiveUserAccounts\saveCustomSettings().