PHP Класс SimpleSAML_SessionHandlerPHP, simplesamlphp

This file defines a session handler which uses the default php session handler for storage.
Автор: Olav Morken, UNINETT AS. ([email protected])
Наследование: extends SimpleSAML_SessionHandler
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$cookie_name string This variable contains the session cookie name.

Открытые методы

Метод Описание
getCookieParams ( ) : array Get the cookie parameters that should be used for session cookies.
getCookieSessionId ( ) : string | null Retrieve the session ID saved in the session cookie, if there's one.
getSessionCookieName ( ) : string Retrieve the session cookie name.
hasSessionCookie ( ) : boolean Check whether the session cookie is set.
loadSession ( string | null $sessionId = null ) : SimpleSAML_Session | null Load the session from the PHP session array.
newSessionId ( ) : string Create a new session id.
restorePrevious ( ) Restore a previously-existing session.
saveSession ( SimpleSAML_Session $session ) Save the current session to the PHP session array.
setCookie ( string $sessionName, string | null $sessionID, array $cookieParams = null ) Set a session cookie.

Защищенные методы

Метод Описание
__construct ( ) Initialize the PHP session handling. This constructor is protected because it should only be called from SimpleSAML_SessionHandler::createSessionHandler(.

Приватные методы

Метод Описание
sessionStart ( ) This method starts a session, making sure no warnings are generated due to headers being already sent.

Описание методов

__construct() защищенный Метод

..).
protected __construct ( )

getCookieParams() публичный Метод

This function contains some adjustments from the default to provide backwards-compatibility.
См. ссылку: http://www.php.net/manual/en/function.session-get-cookie-params.php
public getCookieParams ( ) : array
Результат array The cookie parameters for our sessions.

getCookieSessionId() публичный Метод

Retrieve the session ID saved in the session cookie, if there's one.
public getCookieSessionId ( ) : string | null
Результат string | null The session id saved in the cookie or null if no session cookie was set.

getSessionCookieName() публичный Метод

Retrieve the session cookie name.
public getSessionCookieName ( ) : string
Результат string The session cookie name.

hasSessionCookie() публичный Метод

This function will only return false if is is certain that the cookie isn't set.
public hasSessionCookie ( ) : boolean
Результат boolean True if it was set, false otherwise.

loadSession() публичный Метод

Load the session from the PHP session array.
public loadSession ( string | null $sessionId = null ) : SimpleSAML_Session | null
$sessionId string | null The ID of the session we should load, or null to use the default.
Результат SimpleSAML_Session | null The session object, or null if it doesn't exist.

newSessionId() публичный Метод

Create a new session id.
public newSessionId ( ) : string
Результат string The new session id.

restorePrevious() публичный Метод

Use this method to restore a previous PHP session existing before SimpleSAMLphp initialized its own session. WARNING: do not use this method directly, unless you know what you are doing. Calling this method directly, outside of SimpleSAML_Session, could cause SimpleSAMLphp's session to be lost or mess the application's one. The session must always be saved properly before calling this method. If you don't understand what this is about, don't use this method.
public restorePrevious ( )

saveSession() публичный Метод

Save the current session to the PHP session array.
public saveSession ( SimpleSAML_Session $session )
$session SimpleSAML_Session The session object we should save.

setCookie() публичный Метод

Set a session cookie.
public setCookie ( string $sessionName, string | null $sessionID, array $cookieParams = null )
$sessionName string The name of the session.
$sessionID string | null The session ID to use. Set to null to delete the cookie.
$cookieParams array Additional parameters to use for the session cookie.

Описание свойств