ilSessionReminder Class Reference

Collaboration diagram for ilSessionReminder:

Public Member Functions
	__construct (ilObjUser $user, ClockInterface $clock)
	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	MIN_LEAD_TIME = 2
const	SUGGESTED_LEAD_TIME = 5

Private Member Functions
	init ()
	calculateSecondsUntilExpiration ()
	calculateSecondsUntilReminder ()
	isEnoughTimeLeftForReminder ()

Private Attributes
ClockInterface	$clock
ilObjUser	$user
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	(	ilObjUser	$user,
		ClockInterface	$clock
	)

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

References $clock, $user, init(), and ILIAS\Repository\user().

    {
        $this->user = $user;
        $this->clock = $clock;

        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

byLoggedInUser()

static ilSessionReminder::byLoggedInUser ( )

static

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

References $DIC, $ilSetting, $user, ILIAS\Repository\int(), ilSession\SESSION_HANDLING_FIXED, and ilObject\setId().

Referenced by 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()
        );

        return $reminder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateSecondsUntilExpiration()

ilSessionReminder::calculateSecondsUntilExpiration ( )

private

Definition at line 99 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 104 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 144 of file class.ilSessionReminder.php.

References $current_time.

Referenced by calculateSecondsUntilExpiration().

                                    : int
    {
        return $this->current_time;
    }

Here is the caller graph for this function:

getExpirationTime()

ilSessionReminder::getExpirationTime

(

)

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

References $expiration_time.

Referenced by calculateSecondsUntilExpiration().

                                       : int
    {
        return $this->expiration_time;
    }

Here is the caller graph for this function:

getLeadTime()

ilSessionReminder::getLeadTime

(

)

Definition at line 168 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:

getSecondsUntilExpiration()

ilSessionReminder::getSecondsUntilExpiration

(

)

Definition at line 180 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 192 of file class.ilSessionReminder.php.

References $seconds_until_reminder.

                                             : int
    {
        return $this->seconds_until_reminder;
    }

getUser()

ilSessionReminder::getUser

(

)

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

References $user.

Referenced by init(), and isActive().

                             : ilObjUser
    {
        return $this->user;
    }

Here is the caller graph for this function:

init()

ilSessionReminder::init ( )

private

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

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

Referenced by __construct().

                           : void
    {
        $this->setLeadTime(
            ((int) max(
                self::MIN_LEAD_TIME,
                (float) $this->getUser()->getPref('session_reminder_lead_time')
            )) * 60
        );

        $this->setExpirationTime(ilSession::getIdleValue(true) + $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 114 of file class.ilSessionReminder.php.

References ILIAS\Survey\Mode\getId(), getUser(), and isEnoughTimeLeftForReminder().

                              : bool
    {
        return (
            self::isGloballyActivated() &&
            !$this->getUser()->isAnonymous() &&
            $this->getUser()->getId() > 0 &&
            (int) $this->getUser()->getPref('session_reminder_enabled') &&
            $this->isEnoughTimeLeftForReminder()
        );
    }

Here is the call graph for this function:

isEnoughTimeLeftForReminder()

ilSessionReminder::isEnoughTimeLeftForReminder ( )

private

Definition at line 109 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 137 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 149 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 161 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 173 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 185 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 125 of file class.ilSessionReminder.php.

References $user, and ILIAS\Repository\user().

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

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$clock

ClockInterface ilSessionReminder::$clock

private

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

Referenced by __construct().

$current_time

int ilSessionReminder::$current_time = 0

private

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

Referenced by getCurrentTime(), and setCurrentTime().

$expiration_time

int ilSessionReminder::$expiration_time = 0

private

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

Referenced by getExpirationTime(), and setExpirationTime().

$lead_time

int ilSessionReminder::$lead_time = self::SUGGESTED_LEAD_TIME

private

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

Referenced by getLeadTime(), and setLeadTime().

$seconds_until_expiration

int ilSessionReminder::$seconds_until_expiration = 0

private

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

Referenced by getSecondsUntilExpiration(), and setSecondsUntilExpiration().

$seconds_until_reminder

int ilSessionReminder::$seconds_until_reminder = 0

private

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

Referenced by getSecondsUntilReminder(), and setSecondsUntilReminder().

$user

ilObjUser ilSessionReminder::$user

private

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

Referenced by __construct(), byLoggedInUser(), getUser(), and setUser().

MIN_LEAD_TIME

const ilSessionReminder::MIN_LEAD_TIME = 2

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

Referenced by ilSessionReminderCheck\__construct(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

SUGGESTED_LEAD_TIME

const ilSessionReminder::SUGGESTED_LEAD_TIME = 5

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

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

---

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

• Services/Authentication/classes/class.ilSessionReminder.php