class.ilAuthDestroyExpiredSessionsCron.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilAuthDestroyExpiredSessionsCron extends ilCronJob
{
    protected ilLanguage $lng;

    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('auth');
    }

    public function getId(): string
    {
        return 'auth_destroy_expired_sessions';
    }

    public function getTitle(): string
    {
        return $this->lng->txt('auth_cron_destroy_expired_sessions');
    }

    public function getDescription(): string
    {
        return $this->lng->txt('auth_cron_destroy_expired_sessions_desc');
    }

    public function hasAutoActivation(): bool
    {
        return false;
    }

    public function hasFlexibleSchedule(): bool
    {
        return true;
    }

    public function getValidScheduleTypes(): array
    {
        return [
            ILIAS\Cron\Schedule\CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES,
            ILIAS\Cron\Schedule\CronJobScheduleType::SCHEDULE_TYPE_IN_HOURS
        ];
    }

    public function getDefaultScheduleType(): ILIAS\Cron\Schedule\CronJobScheduleType
    {
        return ILIAS\Cron\Schedule\CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES;
    }

    public function getDefaultScheduleValue(): ?int
    {
        return 1;
    }

    public function isManuallyExecutable(): bool
    {
        return false;
    }

    public function run(): ilCronJobResult
    {
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_OK);

        $num_destroyed_sessions = ilSession::_destroyExpiredSessions();
        ilSessionStatistics::aggretateRaw(time());
        $result->setMessage('Number of destroyed sessions: ' . $num_destroyed_sessions);

        return $result;
    }
}