ilSessionReminder Class Reference

Collaboration diagram for ilSessionReminder:

Public Member Functions
	__construct (private ilObjUser $user, private ClockInterface $clock, private ilSetting $settings)
	getGlobalSessionReminderLeadTime ()
	getEffectiveLeadTime ()
	getMaxPossibleLeadTime ()
	isActive ()
	setUser (ilObjUser $user)
	getUser ()
	setCurrentTime (int $current_time)
	getCurrentTime ()
	setExpirationTime (int $expiration_time)
	getExpirationTime ()
	setLeadTime (int $lead_time)
	getLeadTime ()
	setSecondsUntilExpiration (int $seconds_until_expiration)
	getSecondsUntilExpiration ()
	setSecondsUntilReminder (int $seconds_until_reminder)
	getSecondsUntilReminder ()

Static Public Member Functions
static	byLoggedInUser ()

Data Fields
const	LEAD_TIME_DISABLED = 0
const	MIN_LEAD_TIME = 1
const	SUGGESTED_LEAD_TIME = 5

Private Member Functions
	buildValidLeadTime (int $lead_time)
	init ()
	calculateSecondsUntilExpiration ()
	calculateSecondsUntilReminder ()
	isEnoughTimeLeftForReminder ()

Private Attributes
int	$lead_time = self::SUGGESTED_LEAD_TIME
int	$expiration_time = 0
int	$current_time = 0
int	$seconds_until_expiration = 0
int	$seconds_until_reminder = 0

Detailed Description

Definition at line 24 of file class.ilSessionReminder.php.

Constructor & Destructor Documentation

__construct()

ilSessionReminder::__construct	(	private ilObjUser	$user,
		private ClockInterface	$clock,
		private ilSetting	$settings
	)

Definition at line 36 of file class.ilSessionReminder.php.

References init().

      {
        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

buildValidLeadTime()

ilSessionReminder::buildValidLeadTime ( int  $lead_time )

private

Definition at line 71 of file class.ilSessionReminder.php.

References getMaxPossibleLeadTime().

Referenced by getEffectiveLeadTime(), and getGlobalSessionReminderLeadTime().

                                                       : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

byLoggedInUser()

static ilSessionReminder::byLoggedInUser ( )

static

Definition at line 44 of file class.ilSessionReminder.php.

References $DIC.

Referenced by ilUserFieldSettingsTableGUI\fillRow(), ilObjUserGUI\getValues(), ilObjUserGUI\initForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilGlobalPageTemplate\prepareBasicJS().

                                           : 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;
    }

Here is the caller graph for this function:

calculateSecondsUntilExpiration()

ilSessionReminder::calculateSecondsUntilExpiration ( )

private

Definition at line 120 of file class.ilSessionReminder.php.

References getCurrentTime(), getExpirationTime(), and setSecondsUntilExpiration().

Referenced by init().

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

Here is the call graph for this function:

Here is the caller graph for this function:

calculateSecondsUntilReminder()

ilSessionReminder::calculateSecondsUntilReminder ( )

private

Definition at line 125 of file class.ilSessionReminder.php.

References getLeadTime(), getSecondsUntilExpiration(), and setSecondsUntilReminder().

Referenced by init().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentTime()

ilSessionReminder::getCurrentTime

(

)

Definition at line 163 of file class.ilSessionReminder.php.

References $current_time.

Referenced by calculateSecondsUntilExpiration().

                                    : int
    {
        return $this->current_time;
    }

Here is the caller graph for this function:

getEffectiveLeadTime()

ilSessionReminder::getEffectiveLeadTime

(

)

Definition at line 90 of file class.ilSessionReminder.php.

References ilObjUser\_lookupPref(), buildValidLeadTime(), getGlobalSessionReminderLeadTime(), ILIAS\Survey\Mode\getId(), and getUser().

Referenced by init(), and isActive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExpirationTime()

ilSessionReminder::getExpirationTime

(

)

Definition at line 175 of file class.ilSessionReminder.php.

References $expiration_time.

Referenced by calculateSecondsUntilExpiration().

                                       : int
    {
        return $this->expiration_time;
    }

Here is the caller graph for this function:

getGlobalSessionReminderLeadTime()

ilSessionReminder::getGlobalSessionReminderLeadTime

(

)

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

References buildValidLeadTime(), and ILIAS\Repository\settings().

Referenced by getEffectiveLeadTime().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLeadTime()

ilSessionReminder::getLeadTime

(

)

Definition at line 187 of file class.ilSessionReminder.php.

References $lead_time.

Referenced by calculateSecondsUntilReminder(), and isEnoughTimeLeftForReminder().

                                 : int
    {
        return $this->lead_time;
    }

Here is the caller graph for this function:

getMaxPossibleLeadTime()

ilSessionReminder::getMaxPossibleLeadTime

(

)

Definition at line 100 of file class.ilSessionReminder.php.

References ilSession\getSessionExpireValue().

Referenced by buildValidLeadTime().

                                            : int
    {
        $expires = ilSession::getSessionExpireValue();

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSecondsUntilExpiration()

ilSessionReminder::getSecondsUntilExpiration

(

)

Definition at line 199 of file class.ilSessionReminder.php.

References $seconds_until_expiration.

Referenced by calculateSecondsUntilReminder(), and isEnoughTimeLeftForReminder().

                                               : int
    {
        return $this->seconds_until_expiration;
    }

Here is the caller graph for this function:

getSecondsUntilReminder()

ilSessionReminder::getSecondsUntilReminder

(

)

Definition at line 211 of file class.ilSessionReminder.php.

References $seconds_until_reminder.

                                             : int
    {
        return $this->seconds_until_reminder;
    }

getUser()

ilSessionReminder::getUser

(

)

Definition at line 151 of file class.ilSessionReminder.php.

Referenced by getEffectiveLeadTime(), and isActive().

                             : ilObjUser
    {
        return $this->user;
    }

Here is the caller graph for this function:

init()

ilSessionReminder::init ( )

private

Definition at line 107 of file class.ilSessionReminder.php.

References calculateSecondsUntilExpiration(), calculateSecondsUntilReminder(), getEffectiveLeadTime(), ilSession\getIdleValue(), setCurrentTime(), setExpirationTime(), and setLeadTime().

Referenced by __construct().

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

isActive()

ilSessionReminder::isActive

(

)

Definition at line 135 of file class.ilSessionReminder.php.

References getEffectiveLeadTime(), getUser(), and isEnoughTimeLeftForReminder().

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

Here is the call graph for this function:

isEnoughTimeLeftForReminder()

ilSessionReminder::isEnoughTimeLeftForReminder ( )

private

Definition at line 130 of file class.ilSessionReminder.php.

References getLeadTime(), and getSecondsUntilExpiration().

Referenced by isActive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentTime()

ilSessionReminder::setCurrentTime

(

int

$current_time

)

Definition at line 156 of file class.ilSessionReminder.php.

References $current_time.

Referenced by init().

                                                     : self
    {
        $this->current_time = $current_time;

        return $this;
    }

Here is the caller graph for this function:

setExpirationTime()

ilSessionReminder::setExpirationTime

(

int

$expiration_time

)

Definition at line 168 of file class.ilSessionReminder.php.

References $expiration_time.

Referenced by init().

                                                           : self
    {
        $this->expiration_time = $expiration_time;

        return $this;
    }

Here is the caller graph for this function:

setLeadTime()

ilSessionReminder::setLeadTime

(

int

$lead_time

)

Definition at line 180 of file class.ilSessionReminder.php.

References $lead_time.

Referenced by init().

                                               : self
    {
        $this->lead_time = $lead_time;

        return $this;
    }

Here is the caller graph for this function:

setSecondsUntilExpiration()

ilSessionReminder::setSecondsUntilExpiration

(

int

$seconds_until_expiration

)

Definition at line 192 of file class.ilSessionReminder.php.

References $seconds_until_expiration.

Referenced by calculateSecondsUntilExpiration().

                                                                            : self
    {
        $this->seconds_until_expiration = $seconds_until_expiration;

        return $this;
    }

Here is the caller graph for this function:

setSecondsUntilReminder()

ilSessionReminder::setSecondsUntilReminder

(

int

$seconds_until_reminder

)

Definition at line 204 of file class.ilSessionReminder.php.

References $seconds_until_reminder.

Referenced by calculateSecondsUntilReminder().

                                                                        : self
    {
        $this->seconds_until_reminder = $seconds_until_reminder;

        return $this;
    }

Here is the caller graph for this function:

setUser()

ilSessionReminder::setUser

(

ilObjUser

$user

)

Definition at line 144 of file class.ilSessionReminder.php.

References ILIAS\Repository\user().

                                            : self
    {
        $this->user = $user;

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$current_time

int ilSessionReminder::$current_time = 0

private

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

Referenced by getCurrentTime(), and setCurrentTime().

$expiration_time

int ilSessionReminder::$expiration_time = 0

private

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

Referenced by getExpirationTime(), and setExpirationTime().

$lead_time

int ilSessionReminder::$lead_time = self::SUGGESTED_LEAD_TIME

private

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

Referenced by getLeadTime(), and setLeadTime().

$seconds_until_expiration

int ilSessionReminder::$seconds_until_expiration = 0

private

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

Referenced by getSecondsUntilExpiration(), and setSecondsUntilExpiration().

$seconds_until_reminder

int ilSessionReminder::$seconds_until_reminder = 0

private

Definition at line 34 of file class.ilSessionReminder.php.

Referenced by getSecondsUntilReminder(), and setSecondsUntilReminder().

LEAD_TIME_DISABLED

const ilSessionReminder::LEAD_TIME_DISABLED = 0

Definition at line 26 of file class.ilSessionReminder.php.

Referenced by ilUserFieldSettingsTableGUI\fillRow(), ILIAS\User\UserGUIRequest\getDefaultSessionReminder(), ilObjUserGUI\initForm(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

MIN_LEAD_TIME

const ilSessionReminder::MIN_LEAD_TIME = 1

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

SUGGESTED_LEAD_TIME

const ilSessionReminder::SUGGESTED_LEAD_TIME = 5

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

Referenced by ilObjUserGUI\initForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ILIAS\User\Setup\DBUpdateSteps10\step_3().

---

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

• components/ILIAS/Authentication/classes/class.ilSessionReminder.php