Inheritance diagram for SessionManager:

Public Member Functions
	__construct (\Magento\Framework\App\Request\Http $request, SidResolverInterface $sidResolver, ConfigInterface $sessionConfig, SaveHandlerInterface $saveHandler, ValidatorInterface $validator, StorageInterface $storage, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory, \Magento\Framework\App\State $appState)

	writeClose ()

	__call ($method, $args)

	start ()

	isSessionExists ()

	getData ($key='', $clear=false)

	getSessionId ()

	getName ()

	setName ($name)

	destroy (array $options=null)

	clearStorage ()

	getCookieDomain ()

	getCookiePath ()

	getCookieLifetime ()

	setSessionId ($sessionId)

	getSessionIdForHost ($urlHost)

	isValidForHost ($host)

	isValidForPath ($path)

	regenerateId ()

	expireSessionCookie ()

Protected Member Functions
	registerSaveHandler ()

	_addHost ()

	_getHosts ()

	_cleanHosts ()

	clearSubDomainSessionCookie ()

Protected Attributes
	$defaultDestroyOptions = ['send_expire_cookie' => true, 'clear_storage' => true]

	$validator

	$request

	$sidResolver

	$sessionConfig

	$saveHandler

	$storage

	$cookieManager

	$cookieMetadataFactory

Static Protected Attributes
static	$urlHostCache = []

Additional Inherited Members
Data Fields inherited from SessionManagerInterface
const	HOST_KEY = '_session_hosts'

Detailed Description

Session Manager @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file SessionManager.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Request\Http	$request,
		SidResolverInterface	$sidResolver,
		ConfigInterface	$sessionConfig,
		SaveHandlerInterface	$saveHandler,
		ValidatorInterface	$validator,
		StorageInterface	$storage,
		\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager,
		\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory,
		\Magento\Framework\App\State	$appState
	)

Parameters

\Magento\Framework\App\Request\Http	$request
SidResolverInterface	$sidResolver
ConfigInterface	$sessionConfig
SaveHandlerInterface	$saveHandler
ValidatorInterface	$validator
StorageInterface	$storage
\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager
\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory
\Magento\Framework\App\State	$appState

Exceptions

Definition at line 107 of file SessionManager.php.

       {
         $this->request = $request;
         $this->sidResolver = $sidResolver;
         $this->sessionConfig = $sessionConfig;
         $this->saveHandler = $saveHandler;
         $this->validator = $validator;
         $this->storage = $storage;
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->appState = $appState;
         $this->start();
     }

Member Function Documentation

◆ __call()

__call	(	$method,
		$args
	)

Storage accessor method

Parameters

string	$method
array	$args

Returns: mixed

Exceptions

Definition at line 147 of file SessionManager.php.

     {
         if (!in_array(substr($method, 0, 3), ['get', 'set', 'uns', 'has'])) {
             throw new \InvalidArgumentException(
                 sprintf('Invalid method %s::%s(%s)', get_class($this), $method, print_r($args, 1))
             );
         }
         $return = call_user_func_array([$this->storage, $method], $args);
         return $return === $this->storage ? $this : $return;
     }

◆ _addHost()

_addHost ( )

protected

Register request host name as used with session

Returns: $this

Definition at line 467 of file SessionManager.php.

     {
         $host = $this->request->getHttpHost();
         if (!$host) {
             return $this;
         }
 
         $hosts = $this->_getHosts();
         $hosts[$host] = true;
         $_SESSION[self::HOST_KEY] = $hosts;
         return $this;
     }

◆ _cleanHosts()

_cleanHosts ( )

protected

Clean all host names that were registered with session

Returns: $this

Definition at line 495 of file SessionManager.php.

     {
         unset($_SESSION[self::HOST_KEY]);
         return $this;
     }

◆ _getHosts()

_getHosts ( )

protected

Get all host names where session was used

Returns: array

Definition at line 485 of file SessionManager.php.

     {
         return $_SESSION[self::HOST_KEY] ?? [];
     }

◆ clearStorage()

clearStorage ( )

Unset all session data

Returns: $this

Implements SessionManagerInterface.

Definition at line 351 of file SessionManager.php.

     {
         $this->storage->unsetData();
         return $this;
     }

◆ clearSubDomainSessionCookie()

clearSubDomainSessionCookie ( )

protected

Expire the session cookie for sub domains

Returns: void

Definition at line 552 of file SessionManager.php.

     {
         foreach (array_keys($this->_getHosts()) as $host) {
             // Delete cookies with the same name for parent domains
             if ($this->sessionConfig->getCookieDomain() !== $host) {
                 $metadata = $this->cookieMetadataFactory->createPublicCookieMetadata();
                 $metadata->setPath($this->sessionConfig->getCookiePath());
                 $metadata->setDomain($host);
                 $metadata->setSecure($this->sessionConfig->getCookieSecure());
                 $metadata->setHttpOnly($this->sessionConfig->getCookieHttpOnly());
                 $this->cookieManager->deleteCookie($this->getName(), $metadata);
             }
         }
     }

◆ destroy()

destroy ( array $options = null )

Destroy/end a session

Parameters

array $options

Returns: void

Implements SessionManagerInterface.

Definition at line 326 of file SessionManager.php.

     {
         $options = $options ?? [];
         $options = array_merge($this->defaultDestroyOptions, $options);
 
         if ($options['clear_storage']) {
             $this->clearStorage();
         }
 
         if (session_status() !== PHP_SESSION_ACTIVE) {
             return;
         }
 
         session_regenerate_id(true);
         session_destroy();
         if ($options['send_expire_cookie']) {
             $this->expireSessionCookie();
         }
     }

◆ expireSessionCookie()

expireSessionCookie ( )

Expire the session cookie

Sends a session cookie with no value, and with an expiry in the past.

Returns: void

Implements SessionManagerInterface.

Definition at line 574 of file SessionManager.php.

     {
         if (!$this->sessionConfig->getUseCookies()) {
             return;
         }
 
         $metadata = $this->cookieMetadataFactory->createPublicCookieMetadata();
         $metadata->setPath($this->sessionConfig->getCookiePath());
         $metadata->setDomain($this->sessionConfig->getCookieDomain());
         $metadata->setSecure($this->sessionConfig->getCookieSecure());
         $metadata->setHttpOnly($this->sessionConfig->getCookieHttpOnly());
         $this->cookieManager->deleteCookie($this->getName(), $metadata);
         $this->clearSubDomainSessionCookie();
     }

◆ getCookieDomain()

getCookieDomain ( )

Retrieve Cookie domain

Returns: string

Implements SessionManagerInterface.

Definition at line 362 of file SessionManager.php.

     {
         return $this->sessionConfig->getCookieDomain();
     }

◆ getCookieLifetime()

getCookieLifetime ( )

Retrieve cookie lifetime

Returns: int

Implements SessionManagerInterface.

Definition at line 382 of file SessionManager.php.

     {
         return $this->sessionConfig->getCookieLifetime();
     }

◆ getCookiePath()

getCookiePath ( )

Retrieve cookie path

Returns: string

Implements SessionManagerInterface.

Definition at line 372 of file SessionManager.php.

     {
         return $this->sessionConfig->getCookiePath();
     }

◆ getData()

getData	(	$key = `''`,
		$clear = `false`
	)

Additional get data with clear mode

Parameters

string	$key
bool	$clear

Returns: mixed

Definition at line 279 of file SessionManager.php.

     {
         $data = $this->storage->getData($key);
         if ($clear && isset($data)) {
             $this->storage->unsetData($key);
         }
         return $data;
     }

◆ getName()

getName ( )

Retrieve session name

Returns: string

Implements SessionManagerInterface.

Definition at line 303 of file SessionManager.php.

     {
         return session_name();
     }

◆ getSessionId()

getSessionId ( )

Retrieve session Id

Returns: string

Implements SessionManagerInterface.

Definition at line 293 of file SessionManager.php.

     {
         return session_id();
     }

◆ getSessionIdForHost()

getSessionIdForHost ( $urlHost )

If session cookie is not applicable due to host or path mismatch - add session id to query

Parameters

string $urlHost can be host or url

Returns: string {session_id_key}={session_id_encrypted} @SuppressWarnings(PHPMD.NPathComplexity)

Implements SessionManagerInterface.

Definition at line 409 of file SessionManager.php.

     {
         $httpHost = $this->request->getHttpHost();
         if (!$httpHost) {
             return '';
         }
 
         $urlHostArr = explode('/', $urlHost, 4);
         if (!empty($urlHostArr[2])) {
             $urlHost = $urlHostArr[2];
         }
         $urlPath = empty($urlHostArr[3]) ? '' : $urlHostArr[3];
 
         if (!isset(self::$urlHostCache[$urlHost])) {
             $urlHostArr = explode(':', $urlHost);
             $urlHost = $urlHostArr[0];
             $sessionId = $httpHost !== $urlHost && !$this->isValidForHost($urlHost) ? $this->getSessionId() : '';
             self::$urlHostCache[$urlHost] = $sessionId;
         }
 
         return $this->isValidForPath($urlPath) ? self::$urlHostCache[$urlHost] : $this->getSessionId();
     }

◆ isSessionExists()

isSessionExists ( )

Does a session exist

Returns: bool

Implements SessionManagerInterface.

Definition at line 264 of file SessionManager.php.

     {
         if (session_status() === PHP_SESSION_NONE && !headers_sent()) {
             return false;
         }
         return true;
     }

◆ isValidForHost()

isValidForHost ( $host )

Check if session is valid for given hostname

Parameters

string $host

Returns: bool

Implements SessionManagerInterface.

Definition at line 438 of file SessionManager.php.

     {
         $hostArr = explode(':', $host);
         $hosts = $this->_getHosts();
         return !empty($hosts[$hostArr[0]]);
     }

◆ isValidForPath()

isValidForPath ( $path )

Check if session is valid for given path

Parameters

string $path

Returns: bool

Implements SessionManagerInterface.

Definition at line 451 of file SessionManager.php.

     {
         $cookiePath = trim($this->getCookiePath(), '/') . '/';
         if ($cookiePath == '/') {
             return true;
         }
 
         $urlPath = trim($path, '/') . '/';
         return strpos($urlPath, $cookiePath) === 0;
     }

◆ regenerateId()

regenerateId ( )

Renew session id and update session cookie

Returns: $this

Implements SessionManagerInterface.

Definition at line 506 of file SessionManager.php.

     {
         if (headers_sent()) {
             return $this;
         }
 
         if ($this->isSessionExists()) {
             // Regenerate the session
             session_regenerate_id();
             $newSessionId = session_id();
             $_SESSION['new_session_id'] = $newSessionId;
 
             // Set destroy timestamp
             $_SESSION['destroyed'] = time();
 
             // Write and close current session;
             session_commit();
 
             // Called after destroy()
             $oldSession = $_SESSION;
 
             // Start session with new session ID
             session_id($newSessionId);
             session_start();
             $_SESSION = $oldSession;
 
             // New session does not need them
             unset($_SESSION['destroyed']);
             unset($_SESSION['new_session_id']);
         } else {
             session_start();
         }
 
         $this->storage->init(isset($_SESSION) ? $_SESSION : []);
 
         if ($this->sessionConfig->getUseCookies()) {
             $this->clearSubDomainSessionCookie();
         }
         return $this;
     }

◆ registerSaveHandler()

registerSaveHandler ( )

protected

Register save handler

Returns: bool

Definition at line 247 of file SessionManager.php.

     {
         return session_set_save_handler(
             [$this->saveHandler, 'open'],
             [$this->saveHandler, 'close'],
             [$this->saveHandler, 'read'],
             [$this->saveHandler, 'write'],
             [$this->saveHandler, 'destroy'],
             [$this->saveHandler, 'gc']
         );
     }

◆ setName()

setName ( $name )

Set session name

Parameters

string $name

Returns: $this

Implements SessionManagerInterface.

Definition at line 314 of file SessionManager.php.

     {
         session_name($name);
         return $this;
     }

◆ setSessionId()

setSessionId ( $sessionId )

Specify session identifier

Parameters

string | null $sessionId

Returns: $this

Implements SessionManagerInterface.

Definition at line 393 of file SessionManager.php.

     {
         $this->_addHost();
         if ($sessionId !== null && preg_match('#^[0-9a-zA-Z,-]+$#', $sessionId)) {
             session_id($sessionId);
         }
         return $this;
     }

◆ start()

start ( )

Configure session handler and start session

Exceptions

Implements SessionManagerInterface.

Definition at line 164 of file SessionManager.php.

     {
         if (!$this->isSessionExists()) {
             \Magento\Framework\Profiler::start('session_start');
 
             try {
                 $this->appState->getAreaCode();
             } catch (\Magento\Framework\Exception\LocalizedException $e) {
                 throw new \Magento\Framework\Exception\SessionException(
                     new \Magento\Framework\Phrase(
                         'Area code not set: Area code must be set before starting a session.'
                     ),
                     $e
                 );
             }
 
             // Need to apply the config options so they can be ready by session_start
             $this->initIniOptions();
             $this->registerSaveHandler();
             if (isset($_SESSION['new_session_id'])) {
                 // Not fully expired yet. Could be lost cookie by unstable network.
                 session_commit();
                 session_id($_SESSION['new_session_id']);
             }
             $sid = $this->sidResolver->getSid($this);
             // potential custom logic for session id (ex. switching between hosts)
             $this->setSessionId($sid);
             session_start();
             if (isset($_SESSION['destroyed'])
                 && $_SESSION['destroyed'] < time() - $this->sessionConfig->getCookieLifetime()
             ) {
                 $this->destroy(['clear_storage' => true]);
             }
 
             $this->validator->validate($this);
             $this->renewCookie($sid);
 
             register_shutdown_function([$this, 'writeClose']);
 
             $this->_addHost();
             \Magento\Framework\Profiler::stop('session_start');
         }
         $this->storage->init(isset($_SESSION) ? $_SESSION : []);
         return $this;
     }

◆ writeClose()

writeClose ( )

This method needs to support sessions with APC enabled

Returns: void

Implements SessionManagerInterface.

Definition at line 134 of file SessionManager.php.

     {
         session_write_close();
     }

Field Documentation

◆ $cookieManager

$cookieManager

protected

Definition at line 83 of file SessionManager.php.

◆ $cookieMetadataFactory

$cookieMetadataFactory

protected

Definition at line 88 of file SessionManager.php.

◆ $defaultDestroyOptions

$defaultDestroyOptions = ['send_expire_cookie' => true, 'clear_storage' => true]

protected

Definition at line 27 of file SessionManager.php.

◆ $request

$request

protected

Definition at line 48 of file SessionManager.php.

◆ $saveHandler

$saveHandler

protected

Definition at line 69 of file SessionManager.php.

◆ $sessionConfig

$sessionConfig

protected

Definition at line 62 of file SessionManager.php.

◆ $sidResolver

$sidResolver

protected

Definition at line 55 of file SessionManager.php.

◆ $storage

$storage

protected

Definition at line 76 of file SessionManager.php.

◆ $urlHostCache

$urlHostCache = []

staticprotected

Definition at line 34 of file SessionManager.php.

◆ $validator

$validator

protected

Definition at line 41 of file SessionManager.php.

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

vendor/magento/framework/Session/SessionManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ _addHost()

◆ _cleanHosts()

◆ _getHosts()

◆ clearStorage()

◆ clearSubDomainSessionCookie()

◆ destroy()

◆ expireSessionCookie()

◆ getCookieDomain()

◆ getCookieLifetime()

◆ getCookiePath()

◆ getData()

◆ getName()

◆ getSessionId()

◆ getSessionIdForHost()

◆ isSessionExists()

◆ isValidForHost()

◆ isValidForPath()

◆ regenerateId()

◆ registerSaveHandler()

◆ setName()

◆ setSessionId()

◆ start()

◆ writeClose()

Field Documentation

◆ $cookieManager

◆ $cookieMetadataFactory

◆ $defaultDestroyOptions

◆ $request

◆ $saveHandler

◆ $sessionConfig

◆ $sidResolver

◆ $storage

◆ $urlHostCache

◆ $validator