Purge trash by cron. More...

Inheritance diagram for ilSCCronTrash:

Collaboration diagram for ilSCCronTrash:

Public Member Functions
	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

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

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	run ()
	Run job. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

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 11 of file class.ilSCCronTrash.php.

Member Function Documentation

◆ addCustomSettingsToForm()

ilSCCronTrash::addCustomSettingsToForm ( ilPropertyFormGUI $form )

Add custom settings to form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule('sysc');
        
        include_once './Services/Administration/classes/class.ilSetting.php';
        $settings = new ilSetting('sysc');
 
        // limit number
        $num = new ilNumberInputGUI($lng->txt('sysc_trash_limit_num'), 'number');
        $num->setInfo($lng->txt('purge_count_limit_desc'));
        $num->setSize(10);
        $num->setMinValue(1);
        $num->setValue($settings->get('num', ''));
        $form->addItem($num);
        
        $age = new ilNumberInputGUI($lng->txt('sysc_trash_limit_age'), 'age');
        $age->setInfo($lng->txt('purge_age_limit_desc'));
        $age->setSize(4);
        $age->setMinValue(1);
        $age->setMaxLength(4);
        
        if ($settings->get('age', '')) {
            $age->setValue($settings->get('age', ''));
        }
        
        $form->addItem($age);
        
        // limit types
        $types = new ilSelectInputGUI($lng->txt('sysc_trash_limit_type'), 'types');
        $sub_objects = $GLOBALS['DIC']['tree']->lookupTrashedObjectTypes();
        
        $options = array();
        $options[0] = '';
        foreach ($sub_objects as $obj_type) {
            if (!$GLOBALS['DIC']['objDefinition']->isRBACObject($obj_type) or !$GLOBALS['DIC']['objDefinition']->isAllowedInRepository($obj_type)) {
                continue;
            }
            $options[$obj_type] = $lng->txt('obj_' . $obj_type);
        }
        asort($options);
        $types->setOptions($options);
        $types->setValue($settings->get('types', ''));
        $form->addItem($types);
        
        return $form;
    }

References $DIC, $form, $GLOBALS, $lng, and PHPMailer\PHPMailer\$options.

◆ getDefaultScheduleType()

ilSCCronTrash::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_WEEKLY;
    }

References ilCronJob\SCHEDULE_TYPE_WEEKLY.

◆ getDefaultScheduleValue()

ilSCCronTrash::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return 1;
    }

◆ getDescription()

ilSCCronTrash::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
            
        $GLOBALS['DIC']['lng']->loadLanguageModule('sysc');
        return $lng->txt('sysc_cron_empty_trash_desc');
    }

References $DIC, $GLOBALS, and $lng.

◆ getId()

ilSCCronTrash::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return 'sysc_trash';
    }

◆ getTitle()

ilSCCronTrash::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
            
        $GLOBALS['DIC']['lng']->loadLanguageModule('sysc');
        return $lng->txt('sysc_cron_empty_trash');
    }

References $DIC, $GLOBALS, and $lng.

◆ getValidScheduleTypes()

ilSCCronTrash::getValidScheduleTypes ( )

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

Returns: int[]

Reimplemented from ilCronJob.

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

    {
        return array(
            self::SCHEDULE_TYPE_DAILY,
            self::SCHEDULE_TYPE_WEEKLY,
            self::SCHEDULE_TYPE_MONTHLY,
            self::SCHEDULE_TYPE_QUARTERLY,
            self::SCHEDULE_TYPE_YEARLY
        );
    }

◆ hasAutoActivation()

ilSCCronTrash::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasCustomSettings()

ilSCCronTrash::hasCustomSettings ( )

Returns: bool

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilSCCronTrash::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ run()

ilSCCronTrash::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        include_once './Services/SystemCheck/classes/class.ilSystemCheckTrash.php';
        $trash = new ilSystemCheckTrash();
        $trash->setMode(ilSystemCheckTrash::MODE_TRASH_REMOVE);
            
        include_once './Services/Administration/classes/class.ilSetting.php';
        $settings = new ilSetting('sysc');
        
        $trash->setNumberLimit($settings->get('num', 0));
        $trash->setTypesLimit((array) $settings->get('types'));
        
        $age = $settings->get('age', 0);
        if ($age) {
            $date = new ilDateTime(time(), IL_CAL_UNIX);
            $date->increment(IL_CAL_DAY, (int) $age * -1);
            $trash->setAgeLimit($date);
        }
        $trash->start();
 
        include_once './Services/Cron/classes/class.ilCronJobResult.php';
        ;
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

References $result, IL_CAL_DAY, IL_CAL_UNIX, ilSystemCheckTrash\MODE_TRASH_REMOVE, and ilCronJobResult\STATUS_OK.

◆ saveCustomSettings()

ilSCCronTrash::saveCustomSettings ( ilPropertyFormGUI $a_form )

Save custom settings.

Parameters

ilPropertyFormGUI $a_form

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        include_once './Services/Administration/classes/class.ilSetting.php';
        $settings = new ilSetting('sysc');
        
        $settings->set('num', $a_form->getInput('number'));
        $settings->set('age', $a_form->getInput('age'));
        $settings->set('types', $a_form->getInput('types'));
        
        return true; // #18579
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

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

Services/SystemCheck/classes/class.ilSCCronTrash.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomSettingsToForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ run()

◆ saveCustomSettings()