Inheritance diagram for ilCleanCOPageHistoryCronjob:

Collaboration diagram for ilCleanCOPageHistoryCronjob:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	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, ?int $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 (?int $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
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCleanCOPageHistoryCronjob::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCleanCOPageHistoryCronjob::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

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

                                                                      : 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);
    }

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

Here is the call graph for this function:

◆ getCronDays()

ilCleanCOPageHistoryCronjob::getCronDays ( )

protected

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

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

References $settings, and ilSetting\get().

Referenced by addCustomSettingsToForm(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCleanCOPageHistoryCronjob::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCleanCOPageHistoryCronjob::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilCleanCOPageHistoryCronjob::getDescription ( )

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

◆ getId()

ilCleanCOPageHistoryCronjob::getId ( )

Reimplemented from ilCronJob.

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

                           : string
    {
        return "copg_history_cleanup";
    }

◆ getKeepEntries()

ilCleanCOPageHistoryCronjob::getKeepEntries ( )

protected

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

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

References $settings, and ilSetting\get().

Referenced by addCustomSettingsToForm(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilCleanCOPageHistoryCronjob::getTitle ( )

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilCleanCOPageHistoryCronjob::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCleanCOPageHistoryCronjob::hasCustomSettings ( )

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCleanCOPageHistoryCronjob::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

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

                                         : bool
    {
        return false;
    }

◆ run()

ilCleanCOPageHistoryCronjob::run ( )

Reimplemented from ilCronJob.

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

                         : 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;
    }

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

Here is the call graph for this function:

◆ saveCustomSettings()

ilCleanCOPageHistoryCronjob::saveCustomSettings ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

◆ setCronDays()

ilCleanCOPageHistoryCronjob::setCronDays ( int $days )

protected

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

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

References $settings, and ilSetting\set().

Referenced by saveCustomSettings().

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 164 of file class.ilCleanCOPageHistoryCronjob.php.

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