ilLoggerCronCleanErrorFiles Class Reference

Inheritance diagram for ilLoggerCronCleanErrorFiles:

Collaboration diagram for ilLoggerCronCleanErrorFiles:

Public Member Functions
	__construct ()
	getId ()
	Get id. Returns string More...
	getTitle ()
	Get title. Returns string More...
	getDescription ()
	Get description. Returns string More...
	getDefaultScheduleType ()
	Get schedule type. Returns int More...
	getDefaultScheduleValue ()
	Get schedule value. Returns int|array More...
	hasAutoActivation ()
	Is to be activated on "installation". Returns boolean More...
	hasFlexibleSchedule ()
	Can the schedule be configured? Returns boolean More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? Returns boolean More...
	run ()
	Run job. Returns ilCronJobResult More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. Parameters ilPropertyFormGUI $a_form More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
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...

Data Fields
const	DEFAULT_VALUE_OLDER_THAN = 31
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
	readLogDir ($path)
	deleteFile ($path)
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

Definition at line 13 of file class.ilLoggerCronCleanErrorFiles.php.

Constructor & Destructor Documentation

__construct()

ilLoggerCronCleanErrorFiles::__construct

(

)

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        $this->lng = $lng;
        $this->lng->loadLanguageModule("logging");
        $this->settings = new ilSetting('log');
        $this->error_settings = ilLoggingErrorSettings::getInstance();
    }

References $DIC, $lng, ilLoggingErrorSettings\getInstance(), and settings().

Here is the call graph for this function:

Member Function Documentation

addCustomSettingsToForm()

ilLoggerCronCleanErrorFiles::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

Add custom settings to form.

Parameters

ilPropertyFormGUI

$a_form

Reimplemented from ilCronJob.

Definition at line 150 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        $offset = $this->settings->get('clear_older_then');
        if (!$offset) {
            $offset = self::DEFAULT_VALUE_OLDER_THAN;
        }
        $clear_older_then = new ilNumberInputGUI($this->lng->txt('frm_clear_older_then'), 'clear_older_then');
        $clear_older_then->allowDecimals(false);
        $clear_older_then->setMinValue(1, true);
        $clear_older_then->setValue($offset);
        $clear_older_then->setInfo($this->lng->txt('frm_clear_older_then_info'));
 
        $a_form->addItem($clear_older_then);
    }

References ilPropertyFormGUI\addItem(), DEFAULT_VALUE_OLDER_THAN, and settings().

Here is the call graph for this function:

deleteFile()

ilLoggerCronCleanErrorFiles::deleteFile (   $path )

protected

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

    {
        unlink($path);
    }

Referenced by run().

Here is the caller graph for this function:

getDefaultScheduleType()

ilLoggerCronCleanErrorFiles::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_IN_DAYS;
    }

References ilCronJob\SCHEDULE_TYPE_IN_DAYS.

getDefaultScheduleValue()

ilLoggerCronCleanErrorFiles::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

Definition at line 64 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        return 10;
    }

getDescription()

ilLoggerCronCleanErrorFiles::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

Definition at line 48 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        return $this->lng->txt("log_error_file_cleanup_info");
    }

getId()

ilLoggerCronCleanErrorFiles::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "log_error_file_cleanup";
    }

getTitle()

ilLoggerCronCleanErrorFiles::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

Definition at line 40 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        return $this->lng->txt("log_error_file_cleanup_title");
    }

hasAutoActivation()

ilLoggerCronCleanErrorFiles::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasCustomSettings()

ilLoggerCronCleanErrorFiles::hasCustomSettings

(

)

Has cron job any custom setting which can be edited?

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 88 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        return true;
    }

hasFlexibleSchedule()

ilLoggerCronCleanErrorFiles::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

readLogDir()

ilLoggerCronCleanErrorFiles::readLogDir (   $path )

protected

Definition at line 127 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        $ret = array();
 
        $folder = dir($path);
        while ($file_name = $folder->read()) {
            if (filetype($path . "/" . $file_name) != "dir") {
                $ret[] = $file_name;
            }
        }
        $folder->close();
 
        return $ret;
    }

References $ret.

Referenced by run().

Here is the caller graph for this function:

run()

ilLoggerCronCleanErrorFiles::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        $result = new ilCronJobResult();
        $folder = $this->error_settings->folder();
        if (!is_dir($folder)) {
            $result->setStatus(ilCronJobResult::STATUS_OK);
            $result->setMessage($this->lng->txt("log_error_path_not_configured_or_wrong"));
            return $result;
        }
 
        $offset = $this->settings->get('clear_older_then');
        if (!$offset) {
            $offset = self::DEFAULT_VALUE_OLDER_THAN;
        }
 
        $files = $this->readLogDir($folder);
        $delete_date = new ilDateTime(date("Y-m-d"), IL_CAL_DATE);
        $delete_date->increment(ilDateTime::DAY, (-1 * $offset));
 
        foreach ($files as $file) {
            $file_date = date("Y-m-d", filemtime($this->error_settings->folder() . "/" . $file));
 
            if ($file_date <= $delete_date->get(IL_CAL_DATE)) {
                $this->deleteFile($this->error_settings->folder() . "/" . $file);
            }
        }
 
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

References $result, ilDateTime\DAY, DEFAULT_VALUE_OLDER_THAN, deleteFile(), IL_CAL_DATE, readLogDir(), settings(), and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

saveCustomSettings()

ilLoggerCronCleanErrorFiles::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

Parameters

ilPropertyFormGUI

$a_form

Returns

bool

Reimplemented from ilCronJob.

Definition at line 169 of file class.ilLoggerCronCleanErrorFiles.php.

    {
        $this->settings->set('clear_older_then', $a_form->getInput('clear_older_then'));
        return true;
    }

References ilPropertyFormGUI\getInput(), and settings().

Here is the call graph for this function:

Field Documentation

DEFAULT_VALUE_OLDER_THAN

const ilLoggerCronCleanErrorFiles::DEFAULT_VALUE_OLDER_THAN = 31

Definition at line 15 of file class.ilLoggerCronCleanErrorFiles.php.

Referenced by addCustomSettingsToForm(), and run().

---

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

• Services/Logging/classes/error/class.ilLoggerCronCleanErrorFiles.php