ilSessionReminder Class Reference

Collaboration diagram for ilSessionReminder:

Public Member Functions
	calculateSecondsUntilExpiration ()
	calculateSecondsUntilReminder ()
	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	createInstanceWithCurrentUserSession ()

Data Fields
const	MIN_LEAD_TIME = 2
const	SUGGESTED_LEAD_TIME = 5

Protected Member Functions
	__construct ()
	ilSessionReminder constructor. More...
	initWithUserContext ()
	isEnoughTimeLeftForReminder ()

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

ilSessionReminder constructor.

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

    {
    }

Member Function Documentation

calculateSecondsUntilExpiration()

ilSessionReminder::calculateSecondsUntilExpiration

(

)

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

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

Referenced by initWithUserContext().

                                                      : 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

(

)

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

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

Referenced by initWithUserContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

createInstanceWithCurrentUserSession()

static ilSessionReminder::createInstanceWithCurrentUserSession ( )

static

Returns

ilSessionReminder

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

References $DIC, and $user.

Referenced by ilGlobalPageTemplate\prepareBasicJS().

                                                                  : self
    {
        global $DIC;

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

        $reminder = new self();
        $reminder->setUser($user);
        $reminder->initWithUserContext();

        return $reminder;
    }

Here is the caller graph for this function:

getCurrentTime()

ilSessionReminder::getCurrentTime

(

)

Returns

int

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

(

)

Returns

int

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

(

)

Returns

int

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

(

)

Returns

int

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

(

)

Returns

int

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

References $seconds_until_reminder.

                                              : int
    {
        return $this->seconds_until_reminder;
    }

getUser()

ilSessionReminder::getUser

(

)

Returns

ilObjUser

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

References $user.

Referenced by initWithUserContext(), and isActive().

                              : ilObjUser
    {
        return $this->user;
    }

Here is the caller graph for this function:

initWithUserContext()

ilSessionReminder::initWithUserContext ( )

protected

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

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

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

        $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 109 of file class.ilSessionReminder.php.

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

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

Here is the call graph for this function:

isEnoughTimeLeftForReminder()

ilSessionReminder::isEnoughTimeLeftForReminder ( )

protected

Returns

bool

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

)

Parameters

int

$current_time

Returns

$this

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

References $current_time.

Referenced by initWithUserContext().

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

        return $this;
    }

Here is the caller graph for this function:

setExpirationTime()

ilSessionReminder::setExpirationTime

(

int

$expiration_time

)

Parameters

int

$expiration_time

Returns

$this

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

References $expiration_time.

Referenced by initWithUserContext().

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

        return $this;
    }

Here is the caller graph for this function:

setLeadTime()

ilSessionReminder::setLeadTime

(

int

$lead_time

)

Parameters

int

$lead_time

Returns

$this

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

References $lead_time.

Referenced by initWithUserContext().

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

        return $this;
    }

Here is the caller graph for this function:

setSecondsUntilExpiration()

ilSessionReminder::setSecondsUntilExpiration

(

int

$seconds_until_expiration

)

Parameters

int

$seconds_until_expiration

Returns

$this

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

)

Parameters

int

$seconds_until_reminder

Returns

$this

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

)

Parameters

ilObjUser

$user

Returns

$this

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

References $user, and user().

                                             : self
    {
        $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 27 of file class.ilSessionReminder.php.

Referenced by getCurrentTime(), and setCurrentTime().

$expiration_time

ilSessionReminder::$expiration_time = 0

protected

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

Referenced by getExpirationTime(), and setExpirationTime().

$lead_time

ilSessionReminder::$lead_time = 0

protected

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

Referenced by getLeadTime(), and setLeadTime().

$seconds_until_expiration

ilSessionReminder::$seconds_until_expiration = 0

protected

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

Referenced by getSecondsUntilExpiration(), and setSecondsUntilExpiration().

$seconds_until_reminder

ilSessionReminder::$seconds_until_reminder = 0

protected

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

Referenced by getSecondsUntilReminder(), and setSecondsUntilReminder().

$user

ilSessionReminder::$user

protected

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

Referenced by createInstanceWithCurrentUserSession(), getUser(), and setUser().

MIN_LEAD_TIME

const ilSessionReminder::MIN_LEAD_TIME = 2

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

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

SUGGESTED_LEAD_TIME

const ilSessionReminder::SUGGESTED_LEAD_TIME = 5

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