ilBackgroundTaskCronGarbageCollection Class Reference

Background task GC. More...

Inheritance diagram for ilBackgroundTaskCronGarbageCollection:

Collaboration diagram for ilBackgroundTaskCronGarbageCollection:

Public Member Functions
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? 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...
	getValidScheduleTypes ()
	Get all available schedule types. 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

Background task GC.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilBackgroundTaskCronGarbageCollection.php.

Member Function Documentation

getDefaultScheduleType()

ilBackgroundTaskCronGarbageCollection::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

Definition at line 37 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilBackgroundTaskCronGarbageCollection::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilBackgroundTaskCronGarbageCollection::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("bgtask");
        return $lng->txt("bgtask_cron_gc_desc");
    }

References $DIC, and $lng.

getId()

ilBackgroundTaskCronGarbageCollection::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

Definition at line 14 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        return "bgtsk_gc";
    }

getTitle()

ilBackgroundTaskCronGarbageCollection::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

Definition at line 19 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("bgtask");
        return $lng->txt("bgtask_cron_gc_title");
    }

References $DIC, and $lng.

hasAutoActivation()

ilBackgroundTaskCronGarbageCollection::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 47 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        return false;
    }

hasFlexibleSchedule()

ilBackgroundTaskCronGarbageCollection::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 52 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        return true;
    }

run()

ilBackgroundTaskCronGarbageCollection::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

Definition at line 57 of file class.ilBackgroundTaskCronGarbageCollection.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        
        $status = ilCronJobResult::STATUS_NO_ACTION;
        
        $cut = new ilDateTime(strtotime("-1day"), IL_CAL_UNIX);
        
        include_once "Services/BackgroundTask/classes/class.ilBackgroundTask.php";
    
        $set = $ilDB->query("SELECT id FROM " . ilBackgroundTask::DB_NAME .
            " WHERE start_date <= " . $ilDB->quote($cut->get(IL_CAL_DATETIME), "text"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $status = ilCronJobResult::STATUS_OK;
            
            $task = new ilBackgroundTask($row["id"]);
            $handler = $task->getHandlerInstance();
            $handler->deleteTaskAndFiles();
        }
    
        $result = new ilCronJobResult();
        $result->setStatus($status);
        
        return $result;
    }

References $DIC, $handler, $ilDB, $result, $row, ilBackgroundTask\DB_NAME, IL_CAL_DATETIME, IL_CAL_UNIX, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

---

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

• Services/BackgroundTask/classes/class.ilBackgroundTaskCronGarbageCollection.php