class.ilSessionReminder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data\Clock\ClockInterface;
use ILIAS\Data\Factory as DataFactory;

class ilSessionReminder
{
    public const int LEAD_TIME_DISABLED = 0;
    public const int MIN_LEAD_TIME = 1;
    public const int SUGGESTED_LEAD_TIME = 5;

    private int $lead_time = self::SUGGESTED_LEAD_TIME;
    private int $expiration_time = 0;
    private int $current_time = 0;
    private int $seconds_until_expiration = 0;
    private int $seconds_until_reminder = 0;

    public function __construct(
        private ilObjUser $user,
        private readonly ClockInterface $clock,
        private readonly ilSetting $settings
    ) {
        $this->init();
    }

    public static function byLoggedInUser(): self
    {
        global $DIC;

        if (isset($DIC['ilUser'])) {
            $user = $DIC->user();
        } else {
            $user = new ilObjUser();
            $user->setId(0);
        }

        $reminder = new self(
            $user,
            (new DataFactory())->clock()->utc(),
            $DIC->settings()
        );

        return $reminder;
    }

    public function getGlobalSessionReminderLeadTime(): int
    {
        return $this->buildValidLeadTime(
            (int) $this->settings->get('session_reminder_lead_time')
        );
    }

    private function buildValidLeadTime(int $lead_time): int
    {
        $min_value = self::MIN_LEAD_TIME;
        $max_value = $this->getMaxPossibleLeadTime();

        if ($lead_time !== self::LEAD_TIME_DISABLED &&
            ($lead_time < $min_value || $lead_time > $max_value)) {
            $lead_time = self::SUGGESTED_LEAD_TIME;
        }

        return $lead_time !== self::LEAD_TIME_DISABLED ? min(
            max(
                $min_value,
                $lead_time
            ),
            $max_value
        ) : self::LEAD_TIME_DISABLED;
    }

    public function getEffectiveLeadTime(): int
    {
        return $this->buildValidLeadTime(
            (int) ilObjUser::_lookupPref(
                $this->getUser()->getId(),
                'session_reminder_lead_time'
            ) ?: $this->getGlobalSessionReminderLeadTime()
        );
    }

    public function getMaxPossibleLeadTime(): int
    {
        $expires = ilSession::getSessionExpireValue();

        return max(self::MIN_LEAD_TIME, ($expires / 60) - 1);
    }

    private function init(): void
    {
        $this->setLeadTime(
            $this->getEffectiveLeadTime() * 60
        );

        $this->setExpirationTime(ilSession::getIdleValue() + $this->clock->now()->getTimestamp());
        $this->setCurrentTime($this->clock->now()->getTimestamp());

        $this->calculateSecondsUntilExpiration();
        $this->calculateSecondsUntilReminder();
    }

    private function calculateSecondsUntilExpiration(): void
    {
        $this->setSecondsUntilExpiration($this->getExpirationTime() - $this->getCurrentTime());
    }

    private function calculateSecondsUntilReminder(): void
    {
        $this->setSecondsUntilReminder($this->getSecondsUntilExpiration() - $this->getLeadTime());
    }

    private function isEnoughTimeLeftForReminder(): bool
    {
        return $this->getLeadTime() < $this->getSecondsUntilExpiration();
    }

    public function isActive(): bool
    {
        return
            !$this->getUser()->isAnonymous() &&
            $this->getUser()->getId() > 0 &&
            $this->getEffectiveLeadTime() !== self::LEAD_TIME_DISABLED &&
            $this->isEnoughTimeLeftForReminder();
    }

    public function setUser(ilObjUser $user): self
    {
        $this->user = $user;

        return $this;
    }

    public function getUser(): ilObjUser
    {
        return $this->user;
    }

    public function setCurrentTime(int $current_time): self
    {
        $this->current_time = $current_time;

        return $this;
    }

    public function getCurrentTime(): int
    {
        return $this->current_time;
    }

    public function setExpirationTime(int $expiration_time): self
    {
        $this->expiration_time = $expiration_time;

        return $this;
    }

    public function getExpirationTime(): int
    {
        return $this->expiration_time;
    }

    public function setLeadTime(int $lead_time): self
    {
        $this->lead_time = $lead_time;

        return $this;
    }

    public function getLeadTime(): int
    {
        return $this->lead_time;
    }

    public function setSecondsUntilExpiration(int $seconds_until_expiration): self
    {
        $this->seconds_until_expiration = $seconds_until_expiration;

        return $this;
    }

    public function getSecondsUntilExpiration(): int
    {
        return $this->seconds_until_expiration;
    }

    public function setSecondsUntilReminder(int $seconds_until_reminder): self
    {
        $this->seconds_until_reminder = $seconds_until_reminder;

        return $this;
    }

    public function getSecondsUntilReminder(): int
    {
        return $this->seconds_until_reminder;
    }
}