Inheritance diagram for Session:

Public Member Functions
	__construct (\Magento\Framework\App\Request\Http $request, \Magento\Framework\Session\SidResolverInterface $sidResolver, \Magento\Framework\Session\Config\ConfigInterface $sessionConfig, \Magento\Framework\Session\SaveHandlerInterface $saveHandler, \Magento\Framework\Session\ValidatorInterface $validator, \Magento\Framework\Session\StorageInterface $storage, CookieManagerInterface $cookieManager, CookieMetadataFactory $cookieMetadataFactory, \Magento\Framework\App\State $appState, \Magento\Framework\Acl\Builder $aclBuilder, \Magento\Backend\Model\UrlInterface $backendUrl, \Magento\Backend\App\ConfigInterface $config)

	refreshAcl ($user=null)

	isAllowed ($resource, $privilege=null)

	isLoggedIn ()

	prolong ()

	isFirstPageAfterLogin ()

	setIsFirstPageAfterLogin ($value)

	processLogin ()

	processLogout ()

	isValidForPath ($path)

Public Member Functions inherited from SessionManager
	__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 ()

Data Fields
const	XML_PATH_SESSION_LIFETIME = 'admin/security/session_lifetime'

Data Fields inherited from SessionManagerInterface
const	HOST_KEY = '_session_hosts'

Protected Attributes
	$_isFirstAfterLogin

	$_aclBuilder

	$_backendUrl

	$_config

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

	$validator

	$request

	$sidResolver

	$sessionConfig

	$saveHandler

	$storage

	$cookieManager

	$cookieMetadataFactory

Additional Inherited Members
Protected Member Functions inherited from SessionManager
	registerSaveHandler ()

	_addHost ()

	_getHosts ()

	_cleanHosts ()

	clearSubDomainSessionCookie ()

Static Protected Attributes inherited from SessionManager
static	$urlHostCache = []

Detailed Description

Backend Auth session model

@api @method \Magento\User\Model\User|null getUser() @method \Magento\Backend\Model\Auth\Session setUser(\Magento\User\Model\User $value) @method \Magento\Framework\Acl|null getAcl() @method \Magento\Backend\Model\Auth\Session setAcl(\Magento\Framework\Acl $value) @method int getUpdatedAt() @method \Magento\Backend\Model\Auth\Session setUpdatedAt(int $value)

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Todo:: implement solution that keeps is_first_visit flag in session during redirects @api

Since: 100.0.2

Definition at line 27 of file Session.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Request\Http	$request,
		\Magento\Framework\Session\SidResolverInterface	$sidResolver,
		\Magento\Framework\Session\Config\ConfigInterface	$sessionConfig,
		\Magento\Framework\Session\SaveHandlerInterface	$saveHandler,
		\Magento\Framework\Session\ValidatorInterface	$validator,
		\Magento\Framework\Session\StorageInterface	$storage,
		CookieManagerInterface	$cookieManager,
		CookieMetadataFactory	$cookieMetadataFactory,
		\Magento\Framework\App\State	$appState,
		\Magento\Framework\Acl\Builder	$aclBuilder,
		\Magento\Backend\Model\UrlInterface	$backendUrl,
		\Magento\Backend\App\ConfigInterface	$config
	)

Parameters

\Magento\Framework\App\Request\Http	$request
\Magento\Framework\Session\SidResolverInterface	$sidResolver
\Magento\Framework\Session\Config\ConfigInterface	$sessionConfig
\Magento\Framework\Session\SaveHandlerInterface	$saveHandler
\Magento\Framework\Session\ValidatorInterface	$validator
\Magento\Framework\Session\StorageInterface	$storage
CookieManagerInterface	$cookieManager
CookieMetadataFactory	$cookieMetadataFactory
\Magento\Framework\App\State	$appState
\Magento\Framework\Acl\Builder	$aclBuilder
\Magento\Backend\Model\UrlInterface	$backendUrl
\Magento\Backend\App\ConfigInterface	$config

Exceptions

Definition at line 74 of file Session.php.

       {
         $this->_config = $config;
         $this->_aclBuilder = $aclBuilder;
         $this->_backendUrl = $backendUrl;
         parent::__construct(
             $request,
             $sidResolver,
             $sessionConfig,
             $saveHandler,
             $validator,
             $storage,
             $cookieManager,
             $cookieMetadataFactory,
             $appState
         );
     }

Member Function Documentation

◆ isAllowed()

isAllowed	(	$resource,
		$privilege = `null`
	)

Check current user permission on resource and privilege

Parameters

string	$resource
string	$privilege

Returns: boolean

Definition at line 135 of file Session.php.

     {
         $user = $this->getUser();
         $acl = $this->getAcl();
 
         if ($user && $acl) {
             try {
                 return $acl->isAllowed($user->getAclRole(), $resource, $privilege);
             } catch (\Exception $e) {
                 try {
                     if (!$acl->has($resource)) {
                         return $acl->isAllowed($user->getAclRole(), null, $privilege);
                     }
                 } catch (\Exception $e) {
                 }
             }
         }
         return false;
     }

◆ isFirstPageAfterLogin()

isFirstPageAfterLogin ( )

Check if it is the first page after successful login

Returns: bool

Definition at line 192 of file Session.php.

     {
         if ($this->_isFirstAfterLogin === null) {
             $this->_isFirstAfterLogin = $this->getData('is_first_visit', true);
         }
         return $this->_isFirstAfterLogin;
     }

◆ isLoggedIn()

isLoggedIn ( )

Check if user is logged in

Returns: boolean

Implements StorageInterface.

Definition at line 160 of file Session.php.

     {
         return $this->getUser() && $this->getUser()->getId();
     }

◆ isValidForPath()

isValidForPath ( $path )

Skip path validation in backend area

Parameters

string $path

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter) @codeCoverageIgnore

Implements SessionManagerInterface.

Definition at line 252 of file Session.php.

     {
         return true;
     }

◆ processLogin()

processLogin ( )

Process of configuring of current auth storage when login was performed

Returns: \Magento\Backend\Model\Auth\Session

Implements StorageInterface.

Definition at line 217 of file Session.php.

     {
         if ($this->getUser()) {
             $this->regenerateId();
 
             if ($this->_backendUrl->useSecretKey()) {
                 $this->_backendUrl->renewSecretUrls();
             }
 
             $this->setIsFirstPageAfterLogin(true);
             $this->setAcl($this->_aclBuilder->getAcl());
             $this->setUpdatedAt(time());
         }
         return $this;
     }

◆ processLogout()

processLogout ( )

Process of configuring of current auth storage when logout was performed

Returns: \Magento\Backend\Model\Auth\Session

Implements StorageInterface.

Definition at line 238 of file Session.php.

     {
         $this->destroy();
         return $this;
     }

◆ prolong()

prolong ( )

Set session UpdatedAt to current time

Returns: void

Implements StorageInterface.

Definition at line 170 of file Session.php.

     {
         $lifetime = $this->_config->getValue(self::XML_PATH_SESSION_LIFETIME);
         $cookieValue = $this->cookieManager->getCookie($this->getName());
 
         if ($cookieValue) {
             $this->setUpdatedAt(time());
             $cookieMetadata = $this->cookieMetadataFactory->createPublicCookieMetadata()
                 ->setDuration($lifetime)
                 ->setPath($this->sessionConfig->getCookiePath())
                 ->setDomain($this->sessionConfig->getCookieDomain())
                 ->setSecure($this->sessionConfig->getCookieSecure())
                 ->setHttpOnly($this->sessionConfig->getCookieHttpOnly());
             $this->cookieManager->setPublicCookie($this->getName(), $cookieValue, $cookieMetadata);
         }
     }

◆ refreshAcl()

refreshAcl ( $user = null )

Refresh ACL resources stored in session

Parameters

\Magento\User\Model\User $user

Returns: \Magento\Backend\Model\Auth\Session

Definition at line 110 of file Session.php.

     {
         if ($user === null) {
             $user = $this->getUser();
         }
         if (!$user) {
             return $this;
         }
         if (!$this->getAcl() || $user->getReloadAclFlag()) {
             $this->setAcl($this->_aclBuilder->getAcl());
         }
         if ($user->getReloadAclFlag()) {
             $user->unsetData('password');
             $user->setReloadAclFlag('0')->save();
         }
         return $this;
     }

◆ setIsFirstPageAfterLogin()

setIsFirstPageAfterLogin ( $value )

Setter whether the current/next page should be treated as first page after login

Parameters

bool $value

Returns: \Magento\Backend\Model\Auth\Session

Definition at line 206 of file Session.php.

     {
         $this->_isFirstAfterLogin = (bool)$value;
         return $this->setIsFirstVisit($this->_isFirstAfterLogin);
     }

Field Documentation

◆ $_aclBuilder

$_aclBuilder

protected

Definition at line 46 of file Session.php.

◆ $_backendUrl

$_backendUrl

protected

Definition at line 51 of file Session.php.

◆ $_config

$_config

protected

Definition at line 56 of file Session.php.

◆ $_isFirstAfterLogin

$_isFirstAfterLogin

protected

Definition at line 39 of file Session.php.

◆ XML_PATH_SESSION_LIFETIME

const XML_PATH_SESSION_LIFETIME = 'admin/security/session_lifetime'

Admin session lifetime config path

Definition at line 32 of file Session.php.

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

vendor/magento/module-backend/Model/Auth/Session.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ isAllowed()

◆ isFirstPageAfterLogin()

◆ isLoggedIn()

◆ isValidForPath()

◆ processLogin()

◆ processLogout()

◆ prolong()

◆ refreshAcl()

◆ setIsFirstPageAfterLogin()

Field Documentation

◆ $_aclBuilder

◆ $_backendUrl

◆ $_config

◆ $_isFirstAfterLogin

◆ XML_PATH_SESSION_LIFETIME