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 ($a_status, $a_user_id)
	Set authenticated. More...
	isExpired ()
	Check if current is or was expired in last request. More...
	setExpired ($a_status)
	Set session expired. More...
	setUserId ($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...

Data Fields
const	SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'
const	SESSION_AUTH_USER_ID = '_authsession_user_id'
const	SESSION_AUTH_EXPIRED = '_authsession_expired'

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

Private Member Functions
	__construct (\ilLogger $logger)
	Consctructor. More...

Private Attributes
	$logger = null
	$id = ''
	$user_id = 0
	$expired = false
	$authenticated = false

Static Private Attributes
static	$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 13 of file class.ilAuthSession.php.

Constructor & Destructor Documentation

__construct()

ilAuthSession::__construct ( \ilLogger  $logger )

private

Consctructor.

Parameters

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

References $logger.

    {
        $this->logger = $logger;
    }

Member Function Documentation

getId()

ilAuthSession::getId

(

)

get session id

Returns

string

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

References $id.

Referenced by regenerateId(), and validateExpiration().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstance()

static ilAuthSession::getInstance ( \ilLogger  $logger )

static

Get instance.

Parameters

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

References $logger.

Referenced by ilInitialisation\initSession().

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

References $logger.

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

    {
        return $this->logger;
    }

Here is the caller graph for this function:

getUserId()

ilAuthSession::getUserId

(

)

Get authenticated user id.

Returns

int

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

References $user_id.

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

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

init()

ilAuthSession::init

(

)

Start auth session.

Returns

boolean

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

References $user_id, ilSession\get(), getLogger(), setId(), setUserId(), and validateExpiration().

    {
        session_start();
        
        $this->setId(session_id());
        
        $user_id = (int) ilSession::get(self::SESSION_AUTH_USER_ID);

        if ($user_id) {
            $this->getLogger()->debug('Resuming old session for user: ' . $user_id);
            $this->setUserId(ilSession::get(self::SESSION_AUTH_USER_ID));
            $this->expired = (int) ilSession::get(self::SESSION_AUTH_EXPIRED);
            $this->authenticated = (int) ilSession::get(self::SESSION_AUTH_AUTHENTICATED);
            
            $this->validateExpiration();
        } else {
            $this->getLogger()->debug('Started new session.');
            $this->setUserId(0);
            $this->expired = false;
            $this->authenticated = false;
        }
        return true;
    }

Here is the call graph for this function:

isAuthenticated()

ilAuthSession::isAuthenticated

(

)

Check if session is authenticated.

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

References $authenticated.

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

    {
        return $this->authenticated;
    }

Here is the caller graph for this function:

isExpired()

ilAuthSession::isExpired

(

)

Check if current is or was expired in last request.

Returns

type

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

References $expired.

Referenced by isValid(), and validateExpiration().

    {
        return (bool) $this->expired;
    }

Here is the caller graph for this function:

isValid()

ilAuthSession::isValid

(

)

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

Returns

bool

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

References isAuthenticated(), and isExpired().

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

Here is the call graph for this function:

logout()

ilAuthSession::logout

(

)

Logout user => stop session.

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

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

Referenced by ilSessionControl\checkCurrentSessionIsAllowed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

regenerateId()

ilAuthSession::regenerateId

(

)

Regenerate id.

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

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

Referenced by setAuthenticated().

    {
        $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	(		$a_status,
			$a_user_id
	)

Set authenticated.

Parameters

authentication

status $a_status

Returns

type

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

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

Referenced by logout().

    {
        $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, (int) $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

(

$a_status

)

Set session expired.

Parameters

type

$a_status

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

References ilSession\set().

Referenced by setAuthenticated(), and validateExpiration().

    {
        $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 (   $a_id )

protected

Set id.

Parameters

string

$a_id

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

Referenced by init(), and regenerateId().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setUserId()

ilAuthSession::setUserId

(

$a_id

)

Set authenticated user id.

Parameters

int

$a_id

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

Referenced by init().

    {
        $this->user_id = $a_id;
    }

Here is the caller graph for this function:

validateExpiration()

ilAuthSession::validateExpiration ( )

protected

Check expired value of session.

Returns

bool

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

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

Referenced by init().

    {
        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

ilAuthSession::$authenticated = false

private

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

Referenced by isAuthenticated().

$expired

ilAuthSession::$expired = false

private

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

Referenced by isExpired().

$id

ilAuthSession::$id = ''

private

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

Referenced by getId().

$instance

ilAuthSession::$instance = null

staticprivate

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

$logger

ilAuthSession::$logger = null

private

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

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

$user_id

ilAuthSession::$user_id = 0

private

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

Referenced by getUserId(), and init().

SESSION_AUTH_AUTHENTICATED

const ilAuthSession::SESSION_AUTH_AUTHENTICATED = '_authsession_authenticated'

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

SESSION_AUTH_EXPIRED

const ilAuthSession::SESSION_AUTH_EXPIRED = '_authsession_expired'

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

SESSION_AUTH_USER_ID

const ilAuthSession::SESSION_AUTH_USER_ID = '_authsession_user_id'

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

---

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

• Services/Authentication/classes/class.ilAuthSession.php