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 ILIAS\Cron\CronJob
	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 Member Functions
	getCronDays ()

	setCronDays (int $days)

	getKeepEntries ()

	setKeepEntries (int $entries)

Protected Attributes
HistoryManager	$history_manager

ilSetting	$settings

ilLanguage	$lng

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$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 29 of file class.ilCleanCOPageHistoryCronjob.php.

Constructor & Destructor Documentation

◆ __construct()

ilCleanCOPageHistoryCronjob::__construct ( )

Definition at line 35 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 118 of file class.ilCleanCOPageHistoryCronjob.php.

References $lng, ilPropertyFormGUI\addItem(), getCronDays(), getKeepEntries(), ilLanguage\loadLanguageModule(), ilNumberInputGUI\setSize(), 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 149 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 69 of file class.ilCleanCOPageHistoryCronjob.php.

                                             : JobScheduleType
     {
         return JobScheduleType::DAILY;
     }

◆ getDefaultScheduleValue()

ilCleanCOPageHistoryCronjob::getDefaultScheduleValue ( )

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

References null.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilCleanCOPageHistoryCronjob::getDescription ( )

Definition at line 61 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 48 of file class.ilCleanCOPageHistoryCronjob.php.

                            : string
     {
         return "copg_history_cleanup";
     }

◆ getKeepEntries()

ilCleanCOPageHistoryCronjob::getKeepEntries ( )

protected

Definition at line 161 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 53 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 79 of file class.ilCleanCOPageHistoryCronjob.php.

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCleanCOPageHistoryCronjob::hasCustomSettings ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCleanCOPageHistoryCronjob::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return false;
     }

◆ run()

ilCleanCOPageHistoryCronjob::run ( )

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

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

                          : JobResult
     {
         global $DIC;
 
         $log = ilLoggerFactory::getLogger("copg");
         $log->debug("----- Delete old page history entries, Start -----");
 
         $status = JobResult::STATUS_NO_ACTION;
         $result = new JobResult();
 
         $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 = JobResult::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 141 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 155 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 167 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);
     }