SimpleSAML\SessionHandlerStore Class Reference

Inheritance diagram for SimpleSAML\SessionHandlerStore:

Collaboration diagram for SimpleSAML\SessionHandlerStore:

Public Member Functions
	loadSession ($sessionId=null)
	Load a session from the data store. More...
	saveSession (\SimpleSAML_Session $session)
	Save a session to the data store. More...
Public Member Functions inherited from SimpleSAML\SessionHandlerCookie
	newSessionId ()
	Create a new session id. More...
	getCookieSessionId ()
	Retrieve the session ID saved in the session cookie, if there's one. More...
	getSessionCookieName ()
	Retrieve the session cookie name. More...
	hasSessionCookie ()
	Check whether the session cookie is set. More...
	setCookie ($sessionName, $sessionID, array $cookieParams=null)
	Set a session cookie. More...
Public Member Functions inherited from SimpleSAML\SessionHandler
	newSessionId ()
	Create a new session id. More...
	getCookieSessionId ()
	Retrieve the session ID saved in the session cookie, if there's one. More...
	getSessionCookieName ()
	Retrieve the session cookie name. More...
	saveSession (\SimpleSAML_Session $session)
	Save the session. More...
	loadSession ($sessionId=null)
	Load the session. More...
	setCookie ($sessionName, $sessionID, array $cookieParams=null)
	Set a session cookie. More...
	hasSessionCookie ()
	Check whether the session cookie is set. More...
	getCookieParams ()
	Get the cookie parameters that should be used for session cookies. More...

Protected Member Functions
	__construct (Store $store)
	Initialize the session. More...
Protected Member Functions inherited from SimpleSAML\SessionHandlerCookie
	__construct ()
	This constructor initializes the session id based on what we receive in a cookie. More...
	__construct ()
	This constructor is included in case it is needed in the future. More...

Private Attributes
	$store

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\SessionHandler
static	getSessionHandler ()
	This function retrieves the current instance of the session handler. More...
Protected Attributes inherited from SimpleSAML\SessionHandlerCookie
	$cookie_name
Static Protected Attributes inherited from SimpleSAML\SessionHandler
static	$sessionHandler = null

Detailed Description

Definition at line 12 of file SessionHandlerStore.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\SessionHandlerStore::__construct ( Store  $store )

protected

Initialize the session.

Parameters

\SimpleSAML\Store

$store

The store to use.

Definition at line 28 of file SessionHandlerStore.php.

    {
        parent::__construct();
 
        $this->store = $store;
    }

References $store.

Member Function Documentation

loadSession()

SimpleSAML\SessionHandlerStore::loadSession

(

$sessionId = null

)

Load a session from the data store.

Parameters

string | null

$sessionId

The ID of the session we should load, or null to use the default.

Returns

\SimpleSAML_Session|null The session object, or null if it doesn't exist.

Reimplemented from SimpleSAML\SessionHandler.

Definition at line 43 of file SessionHandlerStore.php.

    {
        assert('is_string($sessionId) || is_null($sessionId)');
 
        if ($sessionId === null) {
            $sessionId = $this->getCookieSessionId();
            if ($sessionId === null) {
                // no session cookie, nothing to load
                return null;
            }
        }
 
        $session = $this->store->get('session', $sessionId);
        if ($session !== null) {
            assert('$session instanceof SimpleSAML_Session');
            return $session;
        }
 
        return null;
    }

References $session.

saveSession()

SimpleSAML\SessionHandlerStore::saveSession

(

\SimpleSAML_Session

$session

)

Save a session to the data store.

Parameters

\SimpleSAML_Session

$session

The session object we should save.

Reimplemented from SimpleSAML\SessionHandler.

Definition at line 70 of file SessionHandlerStore.php.

    {
        $sessionId = $session->getSessionId();
 
        $config = \SimpleSAML_Configuration::getInstance();
        $sessionDuration = $config->getInteger('session.duration', 8 * 60 * 60);
        $expire = time() + $sessionDuration;
 
        $this->store->set('session', $sessionId, $session, $expire);
    }

References $config, $expire, $session, and SimpleSAML_Configuration\getInstance().

Here is the call graph for this function:

Field Documentation

$store

SimpleSAML\SessionHandlerStore::$store

private

Definition at line 20 of file SessionHandlerStore.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/SessionHandlerStore.php