Inheritance diagram for ilCleanCOPageHistoryCronjob:

Collaboration diagram for ilCleanCOPageHistoryCronjob:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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 ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	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 Member Functions
	getCronDays ()

	setCronDays (int $days)

	getKeepEntries ()

	setKeepEntries (int $entries)

Protected Attributes
HistoryManager	$history_manager

ilSetting	$settings

ilLanguage	$lng

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 27 of file class.ilCleanCOPageHistoryCronjob.php.

Constructor & Destructor Documentation

◆ __construct()

ilCleanCOPageHistoryCronjob::__construct ( )

Definition at line 33 of file class.ilCleanCOPageHistoryCronjob.php.

References $DIC, ILIAS\Repository\lng(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->settings = $DIC->settings();
         $this->history_manager = $DIC
             ->copage()
             ->internal()
             ->domain()
             ->history();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCleanCOPageHistoryCronjob::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 116 of file class.ilCleanCOPageHistoryCronjob.php.

References $lng, ilPropertyFormGUI\addItem(), getCronDays(), getKeepEntries(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                                                       : void
     {
         $lng = $this->lng;
         $lng->loadLanguageModule("copg");
 
         $ti = new ilNumberInputGUI(
             $lng->txt("copg_cron_days"),
             "copg_cron_days"
         );
         $ti->setSize(6);
         $ti->setSuffix($lng->txt("copg_days"));
         $ti->setInfo($lng->txt("copg_cron_days_info"));
         $ti->setValue((string) $this->getCronDays());
         $a_form->addItem($ti);
 
         $ti = new ilNumberInputGUI($lng->txt("copg_cron_keep_entries"), "copg_cron_keep_entries");
         $ti->setSize(6);
         $ti->setSuffix($lng->txt("copg_entries"));
         $ti->setInfo($lng->txt("copg_cron_keep_entries_info"));
         $ti->setValue((string) $this->getKeepEntries());
         $a_form->addItem($ti);
     }

Here is the call graph for this function:

◆ getCronDays()

ilCleanCOPageHistoryCronjob::getCronDays ( )

protected

Definition at line 147 of file class.ilCleanCOPageHistoryCronjob.php.

References $settings, and ilSetting\get().

Referenced by addCustomSettingsToForm(), and run().

                                     : int
     {
         $settings = $this->settings;
         return (int) $settings->get("copg_cron_days", "3600");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCleanCOPageHistoryCronjob::getDefaultScheduleType ( )

Definition at line 67 of file class.ilCleanCOPageHistoryCronjob.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCleanCOPageHistoryCronjob::getDefaultScheduleValue ( )

Definition at line 72 of file class.ilCleanCOPageHistoryCronjob.php.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilCleanCOPageHistoryCronjob::getDescription ( )

Definition at line 59 of file class.ilCleanCOPageHistoryCronjob.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                     : string
     {
         $lng = $this->lng;
 
         $lng->loadLanguageModule("copg");
         return $lng->txt("copg_history_cleanup_cron_info");
     }

Here is the call graph for this function:

◆ getId()

ilCleanCOPageHistoryCronjob::getId ( )

Definition at line 46 of file class.ilCleanCOPageHistoryCronjob.php.

                            : string
     {
         return "copg_history_cleanup";
     }

◆ getKeepEntries()

ilCleanCOPageHistoryCronjob::getKeepEntries ( )

protected

Definition at line 159 of file class.ilCleanCOPageHistoryCronjob.php.

References $settings, and ilSetting\get().

Referenced by addCustomSettingsToForm(), and run().

                                        : int
     {
         $settings = $this->settings;
         return (int) $settings->get("copg_cron_keep_entries", "1000");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilCleanCOPageHistoryCronjob::getTitle ( )

Definition at line 51 of file class.ilCleanCOPageHistoryCronjob.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                               : string
     {
         $lng = $this->lng;
 
         $lng->loadLanguageModule("copg");
         return $lng->txt("copg_history_cleanup_cron");
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilCleanCOPageHistoryCronjob::hasAutoActivation ( )

Definition at line 77 of file class.ilCleanCOPageHistoryCronjob.php.

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCleanCOPageHistoryCronjob::hasCustomSettings ( )

Definition at line 87 of file class.ilCleanCOPageHistoryCronjob.php.

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCleanCOPageHistoryCronjob::hasFlexibleSchedule ( )

Definition at line 82 of file class.ilCleanCOPageHistoryCronjob.php.

                                          : bool
     {
         return false;
     }

◆ run()

ilCleanCOPageHistoryCronjob::run ( )

Definition at line 92 of file class.ilCleanCOPageHistoryCronjob.php.

References $DIC, $log, getCronDays(), getKeepEntries(), ilLoggerFactory\getLogger(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                          : ilCronJobResult
     {
         global $DIC;
 
         $log = ilLoggerFactory::getLogger("copg");
         $log->debug("----- Delete old page history entries, Start -----");
 
         $status = ilCronJobResult::STATUS_NO_ACTION;
         $result = new ilCronJobResult();
 
         $x_days = $this->getCronDays();
         $keep_entries = $this->getKeepEntries();
         $log->debug("... $x_days days, keep $keep_entries");
 
         if ($this->history_manager->deleteOldHistoryEntries($x_days, $keep_entries)) {
             $status = ilCronJobResult::STATUS_OK;
         }
 
         $log->debug("----- Delete old page history entries, End -----");
 
         $result->setStatus($status);
         return $result;
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilCleanCOPageHistoryCronjob::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 139 of file class.ilCleanCOPageHistoryCronjob.php.

References ilPropertyFormGUI\getInput(), setCronDays(), and setKeepEntries().

                                                                  : bool
     {
         $this->setCronDays((int) $a_form->getInput("copg_cron_days"));
         $this->setKeepEntries((int) $a_form->getInput("copg_cron_keep_entries"));
 
         return true;
     }

Here is the call graph for this function:

◆ setCronDays()

ilCleanCOPageHistoryCronjob::setCronDays ( int $days )

protected

Definition at line 153 of file class.ilCleanCOPageHistoryCronjob.php.

References $settings, and ilSetting\set().

Referenced by saveCustomSettings().

                                              : void
     {
         $settings = $this->settings;
         $settings->set("copg_cron_days", (string) $days);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setKeepEntries()

ilCleanCOPageHistoryCronjob::setKeepEntries ( int $entries )

protected

Definition at line 165 of file class.ilCleanCOPageHistoryCronjob.php.

References $settings, and ilSetting\set().

Referenced by saveCustomSettings().

                                                    : void
     {
         $settings = $this->settings;
         $settings->set("copg_cron_keep_entries", (string) $entries);
     }