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

Collaboration diagram for ilLoggerCronCleanErrorFiles:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	run ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
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 Member Functions
	readLogDir (string $path)
	deleteFile (string $path)

Protected Attributes
const	DEFAULT_VALUE_OLDER_THAN = 31
ilLanguage	$lng
ilSetting	$settings
ilLoggingErrorSettings	$error_settings
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

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

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

Constructor & Destructor Documentation

__construct()

ilLoggerCronCleanErrorFiles::__construct

(

)

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

addCustomSettingsToForm()

ilLoggerCronCleanErrorFiles::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

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

                                                                      : void
    {
        $offset = $this->settings->get('clear_older_then', '');
        if (!$offset) {
            $offset = (string) 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);
    }

Here is the call graph for this function:

deleteFile()

ilLoggerCronCleanErrorFiles::deleteFile ( string  $path )

protected

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

Referenced by run().

                                               : void
    {
        unlink($path);
    }

Here is the caller graph for this function:

getDefaultScheduleType()

ilLoggerCronCleanErrorFiles::getDefaultScheduleType

(

)

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

                                            : JobScheduleType
    {
        return JobScheduleType::IN_DAYS;
    }

getDefaultScheduleValue()

ilLoggerCronCleanErrorFiles::getDefaultScheduleValue

(

)

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

                                             : int
    {
        return 10;
    }

getDescription()

ilLoggerCronCleanErrorFiles::getDescription

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getId()

ilLoggerCronCleanErrorFiles::getId

(

)

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

                           : string
    {
        return "log_error_file_cleanup";
    }

getTitle()

ilLoggerCronCleanErrorFiles::getTitle

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

hasAutoActivation()

ilLoggerCronCleanErrorFiles::hasAutoActivation

(

)

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

                                       : bool
    {
        return false;
    }

hasCustomSettings()

ilLoggerCronCleanErrorFiles::hasCustomSettings

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilLoggerCronCleanErrorFiles::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

readLogDir()

ilLoggerCronCleanErrorFiles::readLogDir ( string  $path )

protected

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

Referenced by run().

                                               : array
    {
        $ret = [];

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

        return $ret;
    }

Here is the caller graph for this function:

run()

ilLoggerCronCleanErrorFiles::run

(

)

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

References ilDateTime\DAY, deleteFile(), IL_CAL_DATE, ILIAS\Repository\int(), ILIAS\Repository\lng(), readLogDir(), and ILIAS\Repository\settings().

                         : JobResult
    {
        $result = new JobResult();
        $folder = $this->error_settings->folder();
        if (!is_dir($folder)) {
            $result->setStatus(JobResult::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 = (int) $offset;
        } else {
            $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(JobResult::STATUS_OK);
        return $result;
    }

Here is the call graph for this function:

saveCustomSettings()

ilLoggerCronCleanErrorFiles::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

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

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

                                                                 : bool
    {
        $threshold = $a_form->getInput('clear_older_then');
        if ((string) $threshold === '') {
            $this->settings->delete('clear_older_then');
        } else {
            $this->settings->set('clear_older_then', (string) ((int) $a_form->getInput('clear_older_then')));
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$error_settings

ilLoggingErrorSettings ilLoggerCronCleanErrorFiles::$error_settings

protected

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

$lng

ilLanguage ilLoggerCronCleanErrorFiles::$lng

protected

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

$settings

ilSetting ilLoggerCronCleanErrorFiles::$settings

protected

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

DEFAULT_VALUE_OLDER_THAN

const ilLoggerCronCleanErrorFiles::DEFAULT_VALUE_OLDER_THAN = 31

protected

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

---

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

• components/ILIAS/Logging/classes/error/class.ilLoggerCronCleanErrorFiles.php