Purge trash by cron. More...

Inheritance diagram for ilSCCronTrash:

Collaboration diagram for ilSCCronTrash:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	getDefaultScheduleValue ()

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

	hasFlexibleSchedule ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	run ()

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 Attributes
ilLanguage	$lng

ilTree	$tree

ilObjectDefinition	$objDefinition

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Purge trash by cron.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 29 of file class.ilSCCronTrash.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCCronTrash::__construct ( )

Definition at line 35 of file class.ilSCCronTrash.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->objDefinition = $DIC['objDefinition'];
        $this->lng->loadLanguageModule('sysc');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilSCCronTrash::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 96 of file class.ilSCCronTrash.php.

                                                                      : void
    {
        $this->lng->loadLanguageModule('sysc');
 
        $settings = new ilSetting('sysc');
 
        // limit number
        $num = new ilNumberInputGUI($this->lng->txt('sysc_trash_limit_num'), 'number');
        $num->allowDecimals(false);
        $num->setInfo($this->lng->txt('purge_count_limit_desc'));
        $num->setSize(10);
        $num->setMinValue(1);
        $num->setValue($settings->get('num', ''));
        $a_form->addItem($num);
 
        $age = new ilNumberInputGUI($this->lng->txt('sysc_trash_limit_age'), 'age');
        $age->allowDecimals(false);
        $age->setInfo($this->lng->txt('purge_age_limit_desc'));
        $age->setSize(4);
        $age->setMinValue(1);
        $age->setMaxLength(4);
 
        if ($settings->get('age', '')) {
            $age->setValue($settings->get('age', ''));
        }
 
        $a_form->addItem($age);
 
        // limit types
        $types = new ilSelectInputGUI($this->lng->txt('sysc_trash_limit_type'), 'types');
        $sub_objects = $this->tree->lookupTrashedObjectTypes();
 
        $options = [];
        $options[0] = '';
        foreach ($sub_objects as $obj_type) {
            if (!$this->objDefinition->isRBACObject($obj_type) || !$this->objDefinition->isAllowedInRepository($obj_type)) {
                continue;
            }
            $options[$obj_type] = $this->lng->txt('obj_' . $obj_type);
        }
        asort($options);
        $types->setOptions($options);
        $types->setValue($settings->get('types', ''));
        $a_form->addItem($types);
    }

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilSCCronTrash::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 60 of file class.ilSCCronTrash.php.

                                            : JobScheduleType
    {
        return JobScheduleType::WEEKLY;
    }

◆ getDefaultScheduleValue()

ilSCCronTrash::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

◆ getDescription()

ilSCCronTrash::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 55 of file class.ilSCCronTrash.php.

                                    : string
    {
        return $this->lng->txt('sysc_cron_empty_trash_desc');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilSCCronTrash::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return 'sysc_trash';
    }

◆ getTitle()

ilSCCronTrash::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                              : string
    {
        return $this->lng->txt('sysc_cron_empty_trash');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getValidScheduleTypes()

ilSCCronTrash::getValidScheduleTypes ( )

Returns a collection of all valid schedule types for a specific job.

Returns: list<JobScheduleType>

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 65 of file class.ilSCCronTrash.php.

                                           : array
    {
        return [
            JobScheduleType::DAILY,
            JobScheduleType::WEEKLY,
            JobScheduleType::MONTHLY,
            JobScheduleType::QUARTERLY,
            JobScheduleType::YEARLY
        ];
    }

References ILIAS\Cron\Job\Schedule\YEARLY.

◆ hasAutoActivation()

ilSCCronTrash::hasAutoActivation ( )

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

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilSCCronTrash::hasCustomSettings ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilSCCronTrash::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

◆ run()

ilSCCronTrash::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 167 of file class.ilSCCronTrash.php.

                         : JobResult
    {
        $trash = new ilSystemCheckTrash();
        $trash->setMode(ilSystemCheckTrash::MODE_TRASH_REMOVE);
 
        $settings = new ilSetting('sysc');
 
        $trash->setNumberLimit((int) $settings->get('num', '0'));
        $trash->setTypesLimit(array_filter([$settings->get('types', '')]));
 
        $age = (int) $settings->get('age', '0');
        if ($age) {
            $date = new ilDateTime(time(), IL_CAL_UNIX);
            $date->increment(IL_CAL_DAY, $age * -1);
            $trash->setAgeLimit($date);
        }
        $trash->start();
 
        $result = new JobResult();
        $result->setStatus(JobResult::STATUS_OK);
        return $result;
    }

References IL_CAL_DAY, IL_CAL_UNIX, ILIAS\Repository\int(), and ilSystemCheckTrash\MODE_TRASH_REMOVE.

Here is the call graph for this function:

◆ saveCustomSettings()

ilSCCronTrash::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 142 of file class.ilSCCronTrash.php.

                                                                 : bool
    {
        $settings = new ilSetting('sysc');
 
        if ((string) $a_form->getInput('number') === '') {
            $settings->delete('num');
        } else {
            $settings->set('num', (string) ((int) $a_form->getInput('number')));
        }
 
        if ((string) $a_form->getInput('age') === '') {
            $settings->delete('age');
        } else {
            $settings->set('age', (string) ((int) $a_form->getInput('age')));
        }
 
        if ($a_form->getInput('types') === '') {
            $settings->delete('types');
        } else {
            $settings->set('types', $a_form->getInput('types'));
        }
 
        return true; // #18579
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

Field Documentation

◆ $lng

ilLanguage ilSCCronTrash::$lng

protected

Definition at line 31 of file class.ilSCCronTrash.php.

◆ $objDefinition

ilObjectDefinition ilSCCronTrash::$objDefinition

protected

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

◆ $tree

ilTree ilSCCronTrash::$tree

protected

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

The documentation for this class was generated from the following file:

components/ILIAS/SystemCheck/classes/class.ilSCCronTrash.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomSettingsToForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $lng

◆ $objDefinition

◆ $tree