ilSCCronTrash Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSCCronTrash:

Collaboration diagram for ilSCCronTrash:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getValidScheduleTypes ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	run ()
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 Attributes
ilLanguage	$lng
ilTree	$tree
ilObjectDefinition	$objDefinition
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
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 25 of file class.ilSCCronTrash.php.

Constructor & Destructor Documentation

__construct()

ilSCCronTrash::__construct

(

)

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

addCustomSettingsToForm()

ilSCCronTrash::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

References ILIAS\LTI\ToolProvider\$settings, ilPropertyFormGUI\addItem(), ilNumberInputGUI\allowDecimals(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

getDefaultScheduleType()

ilSCCronTrash::getDefaultScheduleType

(

)

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

                                            : int
    {
        return self::SCHEDULE_TYPE_WEEKLY;
    }

getDefaultScheduleValue()

ilSCCronTrash::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return 1;
    }

getDescription()

ilSCCronTrash::getDescription

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getId()

ilSCCronTrash::getId

(

)

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

                           : string
    {
        return 'sysc_trash';
    }

getTitle()

ilSCCronTrash::getTitle

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getValidScheduleTypes()

ilSCCronTrash::getValidScheduleTypes

(

)

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

                                           : array
    {
        return [
            self::SCHEDULE_TYPE_DAILY,
            self::SCHEDULE_TYPE_WEEKLY,
            self::SCHEDULE_TYPE_MONTHLY,
            self::SCHEDULE_TYPE_QUARTERLY,
            self::SCHEDULE_TYPE_YEARLY
        ];
    }

hasAutoActivation()

ilSCCronTrash::hasAutoActivation

(

)

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

                                       : bool
    {
        return false;
    }

hasCustomSettings()

ilSCCronTrash::hasCustomSettings

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilSCCronTrash::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

run()

ilSCCronTrash::run

(

)

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

References ILIAS\LTI\ToolProvider\$settings, IL_CAL_DAY, IL_CAL_UNIX, ILIAS\Repository\int(), ilSystemCheckTrash\MODE_TRASH_REMOVE, and ilCronJobResult\STATUS_OK.

                         : ilCronJobResult
    {
        $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 ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

Here is the call graph for this function:

saveCustomSettings()

ilSCCronTrash::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

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

References ILIAS\LTI\ToolProvider\$settings, and ilPropertyFormGUI\getInput().

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

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilSCCronTrash::$lng

protected

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

$objDefinition

ilObjectDefinition ilSCCronTrash::$objDefinition

protected

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

$tree

ilTree ilSCCronTrash::$tree

protected

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

---

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

• Services/SystemCheck/classes/class.ilSCCronTrash.php