ilAuthSession Class Reference

Collaboration diagram for ilAuthSession:

Public Member Functions
	init ()
	Start auth session. More...
	isValid ()
	Check if current session is valid (authenticated and not expired) More...
	regenerateId ()
	Regenerate id. More...
	logout ()
	Logout user => stop session. More...
	isAuthenticated ()
	Check if session is authenticated. More...
	setAuthenticated (bool $a_status, int $a_user_id)
	Set authenticated. More...
	isFullyAuthenticated ()
	isAnonymouslyAuthenticated ()
	isExpired ()
	Check if current is or was expired in last request. More...
	setExpired (bool $a_status)
	Set session expired. More...
	setUserId (int $a_id)
	Set authenticated user id. More...
	getUserId ()
	Get authenticated user id. More...
	getId ()
	get session id More...

Static Public Member Functions
static	getInstance (ilLogger $logger)

Protected Member Functions
	getLogger ()
	validateExpiration ()
	Check expired value of session. More...
	setId (string $a_id)
	Set id. More...

Private Member Functions
	__construct (ilLogger $logger)

Private Attributes
const string	SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'
const string	SESSION_AUTH_USER_ID = '_authsession_user_id'
const string	SESSION_AUTH_EXPIRED = '_authsession_expired'
ilLogger	$logger
string	$id = ''
int	$user_id = 0
bool	$expired = false
bool	$authenticated = false

Static Private Attributes
static ilAuthSession	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAuthSession::__construct ( ilLogger  $logger )

private

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

    {
        $this->logger = $logger;
    }

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

Here is the call graph for this function:

Member Function Documentation

getId()

ilAuthSession::getId

(

)

get session id

Definition at line 213 of file class.ilAuthSession.php.

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by regenerateId(), and validateExpiration().

Here is the caller graph for this function:

getInstance()

static ilAuthSession::getInstance ( ilLogger  $logger )

static

Definition at line 41 of file class.ilAuthSession.php.

                                                        : ilAuthSession
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new self($logger);
    }

References $instance, and $logger.

Referenced by ilInitialisation\initSession().

Here is the caller graph for this function:

getLogger()

ilAuthSession::getLogger ( )

protected

Definition at line 49 of file class.ilAuthSession.php.

                                  : ilLogger
    {
        return $this->logger;
    }

References $logger.

Referenced by init(), logout(), and regenerateId().

Here is the caller graph for this function:

getUserId()

ilAuthSession::getUserId

(

)

Get authenticated user id.

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

                               : int
    {
        return $this->user_id;
    }

References $user_id.

Referenced by logout(), and ilAuthFrontend\migrateAccount().

Here is the caller graph for this function:

init()

ilAuthSession::init

(

)

Start auth session.

Definition at line 57 of file class.ilAuthSession.php.

                          : bool
    {
        if (session_status() === PHP_SESSION_ACTIVE) {
            $this->getLogger()->error(__METHOD__ . ' called with active session.');
            $this->getLogger()->logStack(ilLogLevel::ERROR);
            return false;
        }
 
        session_start();
 
        $this->setId(session_id());
 
        $user_id = (int) (ilSession::get(self::SESSION_AUTH_USER_ID) ?? ANONYMOUS_USER_ID);
 
        if ($user_id) {
            $this->getLogger()->debug('Resuming old session for user: ' . $user_id);
            $this->setUserId($user_id);
            $this->expired = (bool) ilSession::get(self::SESSION_AUTH_EXPIRED);
            $this->authenticated = (bool) ilSession::get(self::SESSION_AUTH_AUTHENTICATED);
 
            $this->validateExpiration();
        } else {
            $this->getLogger()->debug('Started new session.');
            $this->setUserId(ANONYMOUS_USER_ID);
            $this->expired = false;
            $this->authenticated = false;
        }
        return true;
    }

References $user_id, ANONYMOUS_USER_ID, ilLogLevel\ERROR, ilSession\get(), getLogger(), ILIAS\Repository\int(), setId(), setUserId(), and validateExpiration().

Referenced by logout().

Here is the call graph for this function:

Here is the caller graph for this function:

isAnonymouslyAuthenticated()

ilAuthSession::isAnonymouslyAuthenticated

(

)

Definition at line 147 of file class.ilAuthSession.php.

                                                : bool
    {
        return $this->isValid() && $this->user_id === ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID, and isValid().

Here is the call graph for this function:

isAuthenticated()

ilAuthSession::isAuthenticated

(

)

Check if session is authenticated.

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

                                     : bool
    {
        return $this->authenticated || $this->user_id === ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID.

Referenced by isValid(), and ilAuthFrontend\migrateAccount().

Here is the caller graph for this function:

isExpired()

ilAuthSession::isExpired

(

)

Check if current is or was expired in last request.

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

                               : bool
    {
        return $this->expired && $this->user_id !== ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID.

Referenced by isValid(), and validateExpiration().

Here is the caller graph for this function:

isFullyAuthenticated()

ilAuthSession::isFullyAuthenticated

(

)

Definition at line 142 of file class.ilAuthSession.php.

                                          : bool
    {
        return $this->isValid() && $this->user_id !== ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID, and isValid().

Here is the call graph for this function:

isValid()

ilAuthSession::isValid

(

)

Check if current session is valid (authenticated and not expired)

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

                             : bool
    {
        return !$this->isExpired() && $this->isAuthenticated();
    }

References isAuthenticated(), and isExpired().

Referenced by isAnonymouslyAuthenticated(), and isFullyAuthenticated().

Here is the call graph for this function:

Here is the caller graph for this function:

logout()

ilAuthSession::logout

(

)

Logout user => stop session.

Definition at line 109 of file class.ilAuthSession.php.

                            : void
    {
        $this->getLogger()->debug('Logout called for: ' . $this->getUserId());
        session_regenerate_id(true);
        session_destroy();
 
        $this->init();
        $this->setAuthenticated(true, ANONYMOUS_USER_ID);
    }

References ANONYMOUS_USER_ID, getLogger(), getUserId(), init(), and setAuthenticated().

Here is the call graph for this function:

regenerateId()

ilAuthSession::regenerateId

(

)

Regenerate id.

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

                                  : void
    {
        $old_session_id = session_id();
        session_regenerate_id(true);
        $this->setId(session_id());
        $this->getLogger()->info('Session regenerate id: [' . substr($old_session_id, 0, 5) . '] -> [' . substr($this->getId(), 0, 5) . ']');
    }

References getId(), getLogger(), and setId().

Referenced by setAuthenticated().

Here is the call graph for this function:

Here is the caller graph for this function:

setAuthenticated()

ilAuthSession::setAuthenticated	(	bool	$a_status,
		int	$a_user_id
	)

Set authenticated.

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

                                                                    : void
    {
        $this->authenticated = $a_status;
        $this->user_id = $a_user_id;
        ilSession::set(self::SESSION_AUTH_AUTHENTICATED, $a_status);
        ilSession::set(self::SESSION_AUTH_USER_ID, $a_user_id);
        $this->setExpired(false);
        if ($a_status) {
            $this->regenerateId();
        }
    }

References regenerateId(), ilSession\set(), and setExpired().

Referenced by logout().

Here is the call graph for this function:

Here is the caller graph for this function:

setExpired()

ilAuthSession::setExpired

(

bool

$a_status

)

Set session expired.

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

                                              : void
    {
        $this->expired = $a_status;
        ilSession::set(self::SESSION_AUTH_EXPIRED, (int) $a_status);
    }

References ilSession\set().

Referenced by setAuthenticated(), and validateExpiration().

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilAuthSession::setId ( string  $a_id )

protected

Set id.

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

                                          : void
    {
        $this->id = $a_id;
    }

Referenced by init(), and regenerateId().

Here is the caller graph for this function:

setUserId()

ilAuthSession::setUserId

(

int

$a_id

)

Set authenticated user id.

Definition at line 172 of file class.ilAuthSession.php.

                                        : void
    {
        $this->user_id = $a_id;
    }

Referenced by init().

Here is the caller graph for this function:

validateExpiration()

ilAuthSession::validateExpiration ( )

protected

Check expired value of session.

Definition at line 188 of file class.ilAuthSession.php.

                                           : bool
    {
        if ($this->isExpired()) {
            // keep status
            return false;
        }
 
        if (time() > ilSession::lookupExpireTime($this->getId())) {
            $this->setExpired(true);
            return false;
        }
        return true;
    }

References getId(), isExpired(), ilSession\lookupExpireTime(), and setExpired().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$authenticated

bool ilAuthSession::$authenticated = false

private

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

$expired

bool ilAuthSession::$expired = false

private

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

$id

string ilAuthSession::$id = ''

private

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

Referenced by getId().

$instance

ilAuthSession ilAuthSession::$instance = null

staticprivate

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

Referenced by getInstance().

$logger

ilLogger ilAuthSession::$logger

private

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

Referenced by __construct(), getInstance(), and getLogger().

$user_id

int ilAuthSession::$user_id = 0

private

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

Referenced by getUserId(), and init().

SESSION_AUTH_AUTHENTICATED

const string ilAuthSession::SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'

private

Definition at line 23 of file class.ilAuthSession.php.

SESSION_AUTH_EXPIRED

const string ilAuthSession::SESSION_AUTH_EXPIRED = '_authsession_expired'

private

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

SESSION_AUTH_USER_ID

const string ilAuthSession::SESSION_AUTH_USER_ID = '_authsession_user_id'

private

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

---

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

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