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...
	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)
	Get instance. More...

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	SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'
const	SESSION_AUTH_USER_ID = '_authsession_user_id'
const	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

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilAuthSession::__construct ( \ilLogger  $logger )

private

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

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

    {
        $this->logger = $logger;
    }

Here is the call graph for this function:

Member Function Documentation

getId()

ilAuthSession::getId

(

)

get session id

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

References $id.

Referenced by regenerateId(), and validateExpiration().

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstance()

static ilAuthSession::getInstance ( \ilLogger  $logger )

static

Get instance.

Parameters

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

References $logger.

Referenced by ilInitialisation\initSession().

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

Here is the caller graph for this function:

getLogger()

ilAuthSession::getLogger ( )

protected

Returns

ilLogger

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

References $logger.

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

                                  : ilLogger
    {
        return $this->logger;
    }

Here is the caller graph for this function:

getUserId()

ilAuthSession::getUserId

(

)

Get authenticated user id.

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

References $user_id.

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

                               : int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

init()

ilAuthSession::init

(

)

Start auth session.

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

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

Referenced by logout().

                          : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAuthenticated()

ilAuthSession::isAuthenticated

(

)

Check if session is authenticated.

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

References ANONYMOUS_USER_ID, and ILIAS\Repository\int().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

isExpired()

ilAuthSession::isExpired

(

)

Check if current is or was expired in last request.

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

References ANONYMOUS_USER_ID, and ILIAS\Repository\int().

Referenced by isValid(), and validateExpiration().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

ilAuthSession::isValid

(

)

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

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

References isAuthenticated(), and isExpired().

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

Here is the call graph for this function:

logout()

ilAuthSession::logout

(

)

Logout user => stop session.

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

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

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

        $this->init();
        $this->setAuthenticated(true, ANONYMOUS_USER_ID);
    }

Here is the call graph for this function:

regenerateId()

ilAuthSession::regenerateId

(

)

Regenerate id.

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

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

Referenced by setAuthenticated().

                                  : 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) . ']');
    }

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 141 of file class.ilAuthSession.php.

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

Referenced by logout().

                                                                    : 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();
        }
    }

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 164 of file class.ilAuthSession.php.

References ilSession\set().

Referenced by setAuthenticated(), and validateExpiration().

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

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 206 of file class.ilAuthSession.php.

Referenced by init(), and regenerateId().

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

Here is the caller graph for this function:

setUserId()

ilAuthSession::setUserId

(

int

$a_id

)

Set authenticated user id.

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

Referenced by init().

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

Here is the caller graph for this function:

validateExpiration()

ilAuthSession::validateExpiration ( )

protected

Check expired value of session.

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

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

Referenced by init().

                                           : bool
    {
        if ($this->isExpired()) {
            // keep status
            return false;
        }

        if (time() > ilSession::lookupExpireTime($this->getId())) {
            $this->setExpired(true);
            return false;
        }
        return true;
    }

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 37 of file class.ilAuthSession.php.

$expired

bool ilAuthSession::$expired = false

private

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

$id

string ilAuthSession::$id = ''

private

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

Referenced by getId().

$instance

ilAuthSession ilAuthSession::$instance = null

staticprivate

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

$logger

ilLogger ilAuthSession::$logger

private

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

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

$user_id

int ilAuthSession::$user_id = 0

private

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

Referenced by getUserId().

SESSION_AUTH_AUTHENTICATED

const ilAuthSession::SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'

private

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

SESSION_AUTH_EXPIRED

const ilAuthSession::SESSION_AUTH_EXPIRED = '_authsession_expired'

private

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

SESSION_AUTH_USER_ID

const ilAuthSession::SESSION_AUTH_USER_ID = '_authsession_user_id'

private

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

---

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

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