ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
Public Member Functions | |
setDateTimeProvider (?\Closure $date_time_provider) | |
isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false) | |
getScheduleType () | |
Get current schedule type (if flexible) More... | |
getScheduleValue () | |
Get current schedule value (if flexible) More... | |
setSchedule (?JobScheduleType $a_type, ?int $a_value) | |
Update current schedule (if flexible) More... | |
getAllScheduleTypes () | |
Get all available schedule types. More... | |
getScheduleTypesWithValues () | |
getValidScheduleTypes () | |
Returns a collection of all valid schedule types for a specific job. More... | |
isManuallyExecutable () | |
hasCustomSettings () | |
usesLegacyForms () | |
getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng) | |
addCustomSettingsToForm (\ilPropertyFormGUI $a_form) | |
saveCustomConfiguration (mixed $form_data) | |
saveCustomSettings (\ilPropertyFormGUI $a_form) | |
addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active) | |
activationWasToggled (\ilDBInterface $db, \ilSetting $setting, bool $a_currently_active) | |
Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More... | |
getId () | |
getTitle () | |
getDescription () | |
hasAutoActivation () | |
Is to be activated on "installation", does only work for ILIAS core cron jobs. More... | |
hasFlexibleSchedule () | |
getDefaultScheduleType () | |
getDefaultScheduleValue () | |
run () | |
Protected Attributes | |
JobScheduleType | $schedule_type = null |
int | $schedule_value = null |
Closure | $date_time_provider = null |
Private Member Functions | |
checkWeeklySchedule (\DateTimeImmutable $last_run, \DateTimeImmutable $now) | |
checkSchedule (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value) | |
Definition at line 26 of file CronJob.php.
ILIAS\Cron\CronJob::activationWasToggled | ( | \ilDBInterface | $db, |
\ilSetting | $setting, | ||
bool | $a_currently_active | ||
) |
Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed.
Furthermore only few dependencies may be available in the $DIC.
Definition at line 287 of file CronJob.php.
ILIAS\Cron\CronJob::addCustomSettingsToForm | ( | \ilPropertyFormGUI | $a_form | ) |
Definition at line 253 of file CronJob.php.
Referenced by ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::addToExternalSettingsForm | ( | int | $a_form_id, |
array & | $a_fields, | ||
bool | $a_is_active | ||
) |
array<string,mixed> | $a_fields |
Reimplemented in ilCalendarCronRemoteReader, ilForumCronNotification, ilLDAPCronSynchronization, ilMembershipCronNotifications, and ilCronOerHarvester.
Definition at line 279 of file CronJob.php.
|
private |
Definition at line 43 of file CronJob.php.
|
private |
Definition at line 32 of file CronJob.php.
ILIAS\Cron\CronJob::getAllScheduleTypes | ( | ) |
Get all available schedule types.
Definition at line 196 of file CronJob.php.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::getCustomConfigurationInput | ( | \ILIAS\UI\Factory | $ui_factory, |
\ILIAS\Refinery\Factory | $factory, | ||
\ilLanguage | $lng | ||
) |
Definition at line 241 of file CronJob.php.
Referenced by ilCronManagerGUI\initEditForm().
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
Referenced by ILIAS\Cron\Job\Repository\JobRepositoryImpl\getJobInstance(), ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::getScheduleType | ( | ) |
Get current schedule type (if flexible)
Definition at line 156 of file CronJob.php.
ILIAS\Cron\CronJob::getScheduleTypesWithValues | ( | ) |
Definition at line 204 of file CronJob.php.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::getScheduleValue | ( | ) |
Get current schedule value (if flexible)
Definition at line 168 of file CronJob.php.
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::getValidScheduleTypes | ( | ) |
Returns a collection of all valid schedule types for a specific job.
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilMailCronOrphanedMails, and ilSCCronTrash.
Definition at line 217 of file CronJob.php.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
|
abstract |
Is to be activated on "installation", does only work for ILIAS core cron jobs.
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
ILIAS\Cron\CronJob::hasCustomSettings | ( | ) |
Reimplemented in ilConsultationHourCron, ilCalendarCronRemoteReader, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilForumCronNotification, ilLoggerCronCleanErrorFiles, ilMailCronNotification, ilMailCronOrphanedMails, ilCronOerHarvester, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, and ilCronDeleteNeverLoggedInUserAccounts.
Definition at line 227 of file CronJob.php.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
Referenced by ilCronManagerGUI\initEditForm(), and ilCronManagerGUI\initLegacyEditForm().
ILIAS\Cron\CronJob::isDue | ( | ?\DateTimeImmutable | $last_run, |
?JobScheduleType | $schedule_type, | ||
?int | $schedule_value, | ||
bool | $is_manually_executed = false |
||
) |
Definition at line 135 of file CronJob.php.
ILIAS\Cron\CronJob::isManuallyExecutable | ( | ) |
Reimplemented in ilAuthDestroyExpiredSessionsCron.
Definition at line 222 of file CronJob.php.
Referenced by ilCronManagerGUI\confirm().
|
abstract |
Reimplemented in ilAuthDestroyExpiredSessionsCron, ilBookCronNotification, ilBookingPrefBookCron, ilConsultationHourCron, ilCalendarCronRemoteReader, ilCertificateCron, ilCmiXapiDelCron, ilXapiResultsCronjob, ilCleanCOPageHistoryCronjob, ilTimingsCronReminder, ilExcCronFeedbackNotification, ilExcCronReminders, ilFileSystemCleanTempDirCron, ilForumCronNotification, ilLDAPCronSynchronization, ilLoggerCronCleanErrorFiles, ilLTICronOutcomeService, ilMailCronNotification, ilMailCronOrphanedMails, ilMembershipCronMinMembers, ilMembershipCronNotifications, ilCronOerHarvester, ilCronUpdateOrgUnitPaths, ilLuceneIndexer, ilSkillNotifications, ilPrgInvalidateExpiredProgressesCronJob, ilPrgRestartAssignmentsCronJob, ilPrgUpdateProgressCronJob, ilPrgUserNotRestartedCronJob, ilPrgUserRiskyToFailCronJob, ilSurveyCronNotification, ilSCCronTrash, ilCronFinishUnfinishedTestPasses, ilLPCronObjectStatistics, ilCronDeleteInactivatedUserAccounts, ilCronDeleteInactiveUserAccounts, ilCronDeleteNeverLoggedInUserAccounts, ilUserCronCheckAccounts, ilCronEcsTaskScheduler, and ilWOPICrawler.
ILIAS\Cron\CronJob::saveCustomConfiguration | ( | mixed | $form_data | ) |
mixed | $form_data | The form data provided by the KS (\ILIAS\UI\Component\Input\Container\Container::getData)). The types and structure depend on the structure provided by getCustomConfigurationInput . It might be a single value or a array<string, mixed> -like structure. |
Reimplemented in ilMailCronNotification.
Definition at line 262 of file CronJob.php.
ILIAS\Cron\CronJob::saveCustomSettings | ( | \ilPropertyFormGUI | $a_form | ) |
ILIAS\Cron\CronJob::setDateTimeProvider | ( | ?\Closure | $date_time_provider | ) |
Closure():\DateTimeInterface|null $date_time_provider
Definition at line 105 of file CronJob.php.
ILIAS\Cron\CronJob::setSchedule | ( | ?JobScheduleType | $a_type, |
?int | $a_value | ||
) |
Update current schedule (if flexible)
Definition at line 180 of file CronJob.php.
ILIAS\Cron\CronJob::usesLegacyForms | ( | ) |
Reimplemented in ilMailCronNotification.
Definition at line 236 of file CronJob.php.
|
protected |
Definition at line 30 of file CronJob.php.
|
protected |
Definition at line 28 of file CronJob.php.
|
protected |
Definition at line 29 of file CronJob.php.