class.ilSessionReminder.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilSessionReminder
{
        const MIN_LEAD_TIME = 2;

        const SUGGESTED_LEAD_TIME = 5;
        
        
        protected $user;

        protected $lead_time = 0;

        protected $expiration_time = 0;

        protected $current_time = 0;

        protected $seconds_until_expiration = 0;

        protected $seconds_until_reminder = 0;

        protected function __construct()
        {
        }

        public static function createInstanceWithCurrentUserSession()
        {
                global $ilUser;

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

                return $reminder;
        }

        protected function initWithUserContext()
        {
                global $ilAuth;

                $this->setLeadTime(max(self::MIN_LEAD_TIME, (float)$this->getUser()->getPref('session_reminder_lead_time')) * 60);
                $this->setExpirationTime($ilAuth->sessionValidThru());
                $this->setCurrentTime(time());

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

        public function calculateSecondsUntilExpiration()
        {
                $this->setSecondsUntilExpiration($this->getExpirationTime() - $this->getCurrentTime());
        }

        public function calculateSecondsUntilReminder()
        {
                $this->setSecondsUntilReminder($this->getSecondsUntilExpiration() - $this->getLeadTime());
        }

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

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

        public static function isGloballyActivated()
        {
                global $ilSetting;

                return
                        $ilSetting->get('session_handling_type', ilSession::SESSION_HANDLING_FIXED) == ilSession::SESSION_HANDLING_FIXED &&
                        (int)$ilSetting->get('session_reminder_enabled', 0);
        }

        public function setUser($user)
        {
                $this->user = $user;
                return $this;
        }

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

        public function setCurrentTime($current_time)
        {
                $this->current_time = $current_time;
                return $this;
        }

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

        public function setExpirationTime($expiration_time)
        {
                $this->expiration_time = $expiration_time;
                return $this;
        }

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

        public function setLeadTime($lead_time)
        {
                $this->lead_time = $lead_time;
                return $this;
        }

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

        public function setSecondsUntilExpiration($seconds_until_expiration)
        {
                $this->seconds_until_expiration = $seconds_until_expiration;
                return $this;
        }

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

        public function setSecondsUntilReminder($seconds_until_reminder)
        {
                $this->seconds_until_reminder = $seconds_until_reminder;
                return $this;
        }

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