ilSessionReminder Class Reference

Collaboration diagram for ilSessionReminder:

Public Member Functions
	calculateSecondsUntilExpiration ()
	calculateSecondsUntilReminder ()
	isActive ()
	setUser ($user)
	getUser ()
	setCurrentTime ($current_time)
	getCurrentTime ()
	setExpirationTime ($expiration_time)
	getExpirationTime ()
	setLeadTime ($lead_time)
	getLeadTime ()
	setSecondsUntilExpiration ($seconds_until_expiration)
	getSecondsUntilExpiration ()
	setSecondsUntilReminder ($seconds_until_reminder)
	getSecondsUntilReminder ()

Data Fields
const	MIN_LEAD_TIME = 2
const	SUGGESTED_LEAD_TIME = 5

Protected Member Functions
	__construct ()
	Constructor. More...
	initWithUserContext ()
	isEnoughtTimeLeftForReminder ()

Protected Attributes
	$user
	$lead_time = 0
	$expiration_time = 0
	$current_time = 0
	$seconds_until_expiration = 0
	$seconds_until_reminder = 0

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilSessionReminder::__construct ( )

protected

Constructor.

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

References $ilUser.

        {
        }

Member Function Documentation

calculateSecondsUntilExpiration()

ilSessionReminder::calculateSecondsUntilExpiration

(

)

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

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

Referenced by initWithUserContext().

        {
                $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

(

)

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

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

Referenced by initWithUserContext().

        {
                $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

(

)

Returns

int

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

References $current_time.

Referenced by calculateSecondsUntilExpiration().

        {
                return $this->current_time;
        }

Here is the caller graph for this function:

getExpirationTime()

ilSessionReminder::getExpirationTime

(

)

Returns

int

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

References $expiration_time.

Referenced by calculateSecondsUntilExpiration().

        {
                return $this->expiration_time;
        }

Here is the caller graph for this function:

getLeadTime()

ilSessionReminder::getLeadTime

(

)

Returns

int

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

References $lead_time.

Referenced by calculateSecondsUntilReminder(), and isEnoughtTimeLeftForReminder().

        {
                return $this->lead_time;
        }

Here is the caller graph for this function:

getSecondsUntilExpiration()

ilSessionReminder::getSecondsUntilExpiration

(

)

Returns

int

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

References $seconds_until_expiration.

Referenced by calculateSecondsUntilReminder(), and isEnoughtTimeLeftForReminder().

        {
                return $this->seconds_until_expiration;
        }

Here is the caller graph for this function:

getSecondsUntilReminder()

ilSessionReminder::getSecondsUntilReminder

(

)

Returns

int

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

References $seconds_until_reminder.

        {
                return $this->seconds_until_reminder;
        }

getUser()

ilSessionReminder::getUser

(

)

Returns

ilObjUser

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

References $user.

Referenced by initWithUserContext(), and isActive().

        {
                return $this->user;
        }

Here is the caller graph for this function:

initWithUserContext()

ilSessionReminder::initWithUserContext ( )

protected

Todo:

: php7: done

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

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

        {
                $this->setLeadTime(max(self::MIN_LEAD_TIME, (float)$this->getUser()->getPref('session_reminder_lead_time')) * 60);
                
                include_once './Services/Authentication/classes/class.ilSession.php';
                $this->setExpirationTime(ilSession::getIdleValue(true) + time());
                $this->setCurrentTime(time());

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

Here is the call graph for this function:

isActive()

ilSessionReminder::isActive

(

)

Returns

bool

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

References $ilSetting, getUser(), isEnoughtTimeLeftForReminder(), and ilSession\SESSION_HANDLING_FIXED.

        {
                return
                        self::isGloballyActivated() &&
                        $this->getUser()->getId() != ANONYMOUS_USER_ID &&
                        (int)$this->getUser()->getPref('session_reminder_enabled') &&
                        $this->isEnoughtTimeLeftForReminder();
        }

Here is the call graph for this function:

isEnoughtTimeLeftForReminder()

ilSessionReminder::isEnoughtTimeLeftForReminder ( )

protected

Returns

bool

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

References getLeadTime(), and getSecondsUntilExpiration().

Referenced by isActive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentTime()

ilSessionReminder::setCurrentTime

(

$current_time

)

Parameters

int

$current_time

Returns

ilSessionReminder

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

References $current_time.

Referenced by initWithUserContext().

        {
                $this->current_time = $current_time;
                return $this;
        }

Here is the caller graph for this function:

setExpirationTime()

ilSessionReminder::setExpirationTime

(

$expiration_time

)

Parameters

int

$expiration_time

Returns

ilSessionReminder

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

References $expiration_time.

Referenced by initWithUserContext().

        {
                $this->expiration_time = $expiration_time;
                return $this;
        }

Here is the caller graph for this function:

setLeadTime()

ilSessionReminder::setLeadTime

(

$lead_time

)

Parameters

int

$lead_time

Returns

ilSessionReminder

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

References $lead_time.

Referenced by initWithUserContext().

        {
                $this->lead_time = $lead_time;
                return $this;
        }

Here is the caller graph for this function:

setSecondsUntilExpiration()

ilSessionReminder::setSecondsUntilExpiration

(

$seconds_until_expiration

)

Parameters

int

$seconds_until_expiration

Returns

ilSessionReminder

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

References $seconds_until_expiration.

Referenced by calculateSecondsUntilExpiration().

        {
                $this->seconds_until_expiration = $seconds_until_expiration;
                return $this;
        }

Here is the caller graph for this function:

setSecondsUntilReminder()

ilSessionReminder::setSecondsUntilReminder

(

$seconds_until_reminder

)

Parameters

int

$seconds_until_reminder

Returns

ilSessionReminder

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

References $seconds_until_reminder.

Referenced by calculateSecondsUntilReminder().

        {
                $this->seconds_until_reminder = $seconds_until_reminder;
                return $this;
        }

Here is the caller graph for this function:

setUser()

ilSessionReminder::setUser

(

$user

)

Parameters

ilObjUser

$user

Returns

ilSessionReminder

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

References $user, and user().

        {
                $this->user = $user;
                return $this;
        }

Here is the call graph for this function:

Field Documentation

$current_time

ilSessionReminder::$current_time = 0

protected

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

Referenced by getCurrentTime(), and setCurrentTime().

$expiration_time

ilSessionReminder::$expiration_time = 0

protected

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

Referenced by getExpirationTime(), and setExpirationTime().

$lead_time

ilSessionReminder::$lead_time = 0

protected

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

Referenced by getLeadTime(), and setLeadTime().

$seconds_until_expiration

ilSessionReminder::$seconds_until_expiration = 0

protected

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

Referenced by getSecondsUntilExpiration(), and setSecondsUntilExpiration().

$seconds_until_reminder

ilSessionReminder::$seconds_until_reminder = 0

protected

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

Referenced by getSecondsUntilReminder(), and setSecondsUntilReminder().

$user

ilSessionReminder::$user

protected

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

Referenced by getUser(), and setUser().

MIN_LEAD_TIME

const ilSessionReminder::MIN_LEAD_TIME = 2

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

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

SUGGESTED_LEAD_TIME

const ilSessionReminder::SUGGESTED_LEAD_TIME = 5

Definition at line 19 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