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, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory, \Magento\Framework\App\State $appState, Config\Share $configShare, \Magento\Framework\Url\Helper\Data $coreUrl, \Magento\Customer\Model\Url $customerUrl, ResourceCustomer $customerResource, CustomerFactory $customerFactory, \Magento\Framework\UrlFactory $urlFactory, \Magento\Framework\Session\Generic $session, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\App\Http\Context $httpContext, CustomerRepositoryInterface $customerRepository, GroupManagementInterface $groupManagement, \Magento\Framework\App\Response\Http $response)

	getCustomerConfigShare ()

	setCustomerData (CustomerData $customer)

	getCustomerData ()

	getCustomerDataObject ()

	setCustomerDataObject (CustomerData $customerData)

	setCustomer (Customer $customerModel)

	getCustomer ()

	setCustomerId ($id)

	getCustomerId ()

	getId ()

	setId ($customerId)

	setCustomerGroupId ($id)

	getCustomerGroupId ()

	isLoggedIn ()

	checkCustomerId ($customerId)

	setCustomerAsLoggedIn ($customer)

	setCustomerDataAsLoggedIn ($customer)

	loginById ($customerId)

	logout ()

	authenticate ($loginUrl=null)

	setBeforeAuthUrl ($url)

	setAfterAuthUrl ($url)

	regenerateId ()

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 ()

Protected Member Functions
	_setAuthUrl ($key, $url)

	_logout ()

	_createUrl ()

Protected Member Functions inherited from SessionManager
	registerSaveHandler ()

	_addHost ()

	_getHosts ()

	_cleanHosts ()

	clearSubDomainSessionCookie ()

Protected Attributes
	$_customer

	$_customerResource

	$_customerModel

	$_isCustomerIdChecked = null

	$_customerUrl

	$_coreUrl = null

	$_configShare

	$_session

	$customerRepository

	$_customerFactory

	$_urlFactory

	$_eventManager

	$_httpContext

	$groupManagement

	$response

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

	$validator

	$request

	$sidResolver

	$sessionConfig

	$saveHandler

	$storage

	$cookieManager

	$cookieMetadataFactory

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

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

Detailed Description

Customer session model

@api @method string getNoReferer() @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 22 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,
		\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager,
		\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory,
		\Magento\Framework\App\State	$appState,
		Config\Share	$configShare,
		\Magento\Framework\Url\Helper\Data	$coreUrl,
		\Magento\Customer\Model\Url	$customerUrl,
		ResourceCustomer	$customerResource,
		CustomerFactory	$customerFactory,
		\Magento\Framework\UrlFactory	$urlFactory,
		\Magento\Framework\Session\Generic	$session,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\App\Http\Context	$httpContext,
		CustomerRepositoryInterface	$customerRepository,
		GroupManagementInterface	$groupManagement,
		\Magento\Framework\App\Response\Http	$response
	)

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
\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager
\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory
\Magento\Framework\App\State	$appState
Share	$configShare
\Magento\Framework\Url\Helper\Data	$coreUrl
\Magento\Customer\Model\Url	$customerUrl
ResourceCustomer	$customerResource
CustomerFactory	$customerFactory
\Magento\Framework\UrlFactory	$urlFactory
\Magento\Framework\Session\Generic	$session
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\App\Http\Context	$httpContext
CustomerRepositoryInterface	$customerRepository
GroupManagementInterface	$groupManagement
\Magento\Framework\App\Response\Http	$response

Exceptions

Definition at line 134 of file Session.php.

       {
         $this->_coreUrl = $coreUrl;
         $this->_customerUrl = $customerUrl;
         $this->_configShare = $configShare;
         $this->_customerResource = $customerResource;
         $this->_customerFactory = $customerFactory;
         $this->_urlFactory = $urlFactory;
         $this->_session = $session;
         $this->customerRepository = $customerRepository;
         $this->_eventManager = $eventManager;
         $this->_httpContext = $httpContext;
         parent::__construct(
             $request,
             $sidResolver,
             $sessionConfig,
             $saveHandler,
             $validator,
             $storage,
             $cookieManager,
             $cookieMetadataFactory,
             $appState
         );
         $this->groupManagement = $groupManagement;
         $this->response = $response;
         $this->_eventManager->dispatch('customer_session_init', ['customer_session' => $this]);
     }

Member Function Documentation

◆ _createUrl()

_createUrl ( )

protected

Returns: \Magento\Framework\UrlInterface

Definition at line 572 of file Session.php.

     {
         return $this->_urlFactory->create();
     }

◆ _logout()

_logout ( )

protected

Logout without dispatching event

Returns: $this

Definition at line 525 of file Session.php.

     {
         $this->_customer = null;
         $this->_customerModel = null;
         $this->setCustomerId(null);
         $this->setCustomerGroupId($this->groupManagement->getNotLoggedInGroup()->getId());
         $this->destroy(['clear_storage' => false]);
         return $this;
     }

◆ _setAuthUrl()

_setAuthUrl	(	$key,
		$url
	)

protected

Set auth url

Parameters

string	$key
string	$url

Returns: $this

Definition at line 512 of file Session.php.

     {
         $url = $this->_coreUrl->removeRequestParam($url, $this->sidResolver->getSessionIdQueryParam($this));
         // Add correct session ID to URL if needed
         $url = $this->_createUrl()->getRebuiltUrl($url);
         return $this->storage->setData($key, $url);
     }

◆ authenticate()

authenticate ( $loginUrl = null )

Authenticate controller action by login customer

Parameters

bool | null $loginUrl

Returns: bool

Definition at line 480 of file Session.php.

     {
         if ($this->isLoggedIn()) {
             return true;
         }
         $this->setBeforeAuthUrl($this->_createUrl()->getUrl('*/*/*', ['_current' => true]));
         if (isset($loginUrl)) {
             $this->response->setRedirect($loginUrl);
         } else {
             $arguments = $this->_customerUrl->getLoginUrlParams();
             if ($this->_createUrl()->getUseSession()) {
                 $arguments += [
                     '_query' => [
                         $this->sidResolver->getSessionIdQueryParam($this->_session) => $this->_session->getSessionId(),
                     ]
                 ];
             }
             $this->response->setRedirect(
                 $this->_createUrl()->getUrl(\Magento\Customer\Model\Url::ROUTE_ACCOUNT_LOGIN, $arguments)
             );
         }
 
         return false;
     }

◆ checkCustomerId()

checkCustomerId ( $customerId )

Check exists customer (light check)

Parameters

int $customerId

Returns: bool

Definition at line 394 of file Session.php.

     {
         if ($this->_isCustomerIdChecked === $customerId) {
             return true;
         }
 
         try {
             $this->customerRepository->getById($customerId);
             $this->_isCustomerIdChecked = $customerId;
             return true;
         } catch (\Exception $e) {
             return false;
         }
     }

◆ getCustomer()

getCustomer ( )

Retrieve customer model object

Returns: Customer use getCustomerId() instead

Definition at line 288 of file Session.php.

     {
         if ($this->_customerModel === null) {
             $this->_customerModel = $this->_customerFactory->create()->load($this->getCustomerId());
         }
 
         return $this->_customerModel;
     }

◆ getCustomerConfigShare()

getCustomerConfigShare ( )

Retrieve customer sharing configuration model

Returns: Share

Definition at line 188 of file Session.php.

     {
         return $this->_configShare;
     }

◆ getCustomerData()

getCustomerData ( )

Retrieve customer model object

Returns: CustomerData

Definition at line 220 of file Session.php.

     {
         if (!$this->_customer instanceof CustomerData && $this->getCustomerId()) {
             $this->_customer = $this->customerRepository->getById($this->getCustomerId());
         }
 
         return $this->_customer;
     }

◆ getCustomerDataObject()

getCustomerDataObject ( )

Returns Customer data object with the customer information

Returns: CustomerData

Definition at line 234 of file Session.php.

     {
         /* TODO refactor this after all usages of the setCustomer is refactored */
         return $this->getCustomer()->getDataModel();
     }

◆ getCustomerGroupId()

getCustomerGroupId ( )

Get customer group id If customer is not logged in system, 'not logged in' group id will be returned

Returns: int

Definition at line 362 of file Session.php.

     {
         if ($this->storage->getData('customer_group_id')) {
             return $this->storage->getData('customer_group_id');
         }
         if ($this->getCustomerData()) {
             $customerGroupId = $this->getCustomerData()->getGroupId();
             $this->setCustomerGroupId($customerGroupId);
             return $customerGroupId;
         }
         return Group::NOT_LOGGED_IN_ID;
     }

◆ getCustomerId()

getCustomerId ( )

Retrieve customer id from current session

@api

Returns: int|null

Definition at line 315 of file Session.php.

     {
         if ($this->storage->getData('customer_id')) {
             return $this->storage->getData('customer_id');
         }
         return null;
     }

◆ getId()

getId ( )

Retrieve customer id from current session

Returns: int|null

Definition at line 328 of file Session.php.

     {
         return $this->getCustomerId();
     }

◆ isLoggedIn()

isLoggedIn ( )

Checking customer login status

@api

Returns: bool

Definition at line 381 of file Session.php.

     {
         return (bool)$this->getCustomerId()
             && $this->checkCustomerId($this->getId())
             && !$this->getIsCustomerEmulated();
     }

◆ loginById()

loginById ( $customerId )

Authorization customer by identifier

@api

Parameters

int $customerId

Returns: bool

Definition at line 447 of file Session.php.

     {
         try {
             $customer = $this->customerRepository->getById($customerId);
             $this->setCustomerDataAsLoggedIn($customer);
             return true;
         } catch (\Exception $e) {
             return false;
         }
     }

◆ logout()

logout ( )

Logout customer

@api

Returns: $this

Definition at line 464 of file Session.php.

     {
         if ($this->isLoggedIn()) {
             $this->_eventManager->dispatch('customer_logout', ['customer' => $this->getCustomer()]);
             $this->_logout();
         }
         $this->_httpContext->unsValue(Context::CONTEXT_AUTH);
         return $this;
     }

◆ regenerateId()

regenerateId ( )

Reset core session hosts after resetting session ID

Returns: $this

Implements SessionManagerInterface.

Definition at line 562 of file Session.php.

     {
         parent::regenerateId();
         $this->_cleanHosts();
         return $this;
     }

◆ setAfterAuthUrl()

setAfterAuthUrl ( $url )

Set After auth url

Parameters

string $url

Returns: $this

Definition at line 552 of file Session.php.

     {
         return $this->_setAuthUrl('after_auth_url', $url);
     }

◆ setBeforeAuthUrl()

setBeforeAuthUrl ( $url )

Set Before auth url

Parameters

string $url

Returns: $this

Definition at line 541 of file Session.php.

     {
         return $this->_setAuthUrl('before_auth_url', $url);
     }

◆ setCustomer()

setCustomer ( Customer $customerModel )

Set customer model and the customer id in session

Parameters

Customer $customerModel

Returns: $this use setCustomerId() instead

The next line is a workaround. It is used to distinguish users that are logged in from user data set via methods similar to setCustomerId()

Definition at line 260 of file Session.php.

     {
         $this->_customerModel = $customerModel;
         $this->_httpContext->setValue(
             Context::CONTEXT_GROUP,
             $customerModel->getGroupId(),
             \Magento\Customer\Model\Group::NOT_LOGGED_IN_ID
         );
         $this->setCustomerId($customerModel->getId());
         if (!$customerModel->isConfirmationRequired() && $customerModel->getConfirmation()) {
             $customerModel->setConfirmation(null)->save();
         }
 
         $this->unsIsCustomerEmulated();
 
         return $this;
     }

◆ setCustomerAsLoggedIn()

setCustomerAsLoggedIn ( $customer )

Parameters

Customer $customer

Returns: $this

Definition at line 413 of file Session.php.

     {
         $this->setCustomer($customer);
         $this->_eventManager->dispatch('customer_login', ['customer' => $customer]);
         $this->_eventManager->dispatch('customer_data_object_login', ['customer' => $this->getCustomerDataObject()]);
         $this->regenerateId();
         return $this;
     }

◆ setCustomerData()

setCustomerData ( CustomerData $customer )

Set customer object and setting customer id in session

Parameters

CustomerData $customer

Returns: $this

Definition at line 199 of file Session.php.

     {
         $this->_customer = $customer;
         if ($customer === null) {
             $this->setCustomerId(null);
         } else {
             $this->_httpContext->setValue(
                 Context::CONTEXT_GROUP,
                 $customer->getGroupId(),
                 \Magento\Customer\Model\Group::NOT_LOGGED_IN_ID
             );
             $this->setCustomerId($customer->getId());
         }
         return $this;
     }

◆ setCustomerDataAsLoggedIn()

setCustomerDataAsLoggedIn ( $customer )

Parameters

CustomerData $customer

Returns: $this

Definition at line 426 of file Session.php.

     {
         $this->_httpContext->setValue(Context::CONTEXT_AUTH, true, false);
         $this->setCustomerData($customer);
 
         $customerModel = $this->_customerFactory->create()->updateData($customer);
 
         $this->setCustomer($customerModel);
 
         $this->_eventManager->dispatch('customer_login', ['customer' => $customerModel]);
         $this->_eventManager->dispatch('customer_data_object_login', ['customer' => $customer]);
         return $this;
     }

◆ setCustomerDataObject()

setCustomerDataObject ( CustomerData $customerData )

Set Customer data object with the customer information

Parameters

CustomerData $customerData

Returns: $this

Definition at line 246 of file Session.php.

     {
         $this->setId($customerData->getId());
         $this->getCustomer()->updateData($customerData);
         return $this;
     }

◆ setCustomerGroupId()

setCustomerGroupId ( $id )

Set customer group id

Parameters

int | null $id

Returns: $this

Definition at line 350 of file Session.php.

     {
         $this->storage->setData('customer_group_id', $id);
         return $this;
     }

◆ setCustomerId()

setCustomerId ( $id )

Set customer id

Parameters

int | null $id

Returns: $this

Definition at line 303 of file Session.php.

     {
         $this->storage->setData('customer_id', $id);
         return $this;
     }

◆ setId()

setId ( $customerId )

Set customer id

Parameters

int | null $customerId

Returns: $this

Definition at line 339 of file Session.php.

     {
         return $this->setCustomerId($customerId);
     }

Field Documentation

◆ $_configShare

$_configShare

protected

Definition at line 67 of file Session.php.

◆ $_coreUrl

$_coreUrl = null

protected

Definition at line 62 of file Session.php.

◆ $_customer

$_customer

protected

Definition at line 29 of file Session.php.

◆ $_customerFactory

$_customerFactory

protected

Definition at line 82 of file Session.php.

◆ $_customerModel

$_customerModel

protected

Definition at line 41 of file Session.php.

◆ $_customerResource

$_customerResource

protected

Definition at line 34 of file Session.php.

◆ $_customerUrl

$_customerUrl

protected

Definition at line 55 of file Session.php.

◆ $_eventManager

$_eventManager

protected

Definition at line 92 of file Session.php.

◆ $_httpContext

$_httpContext

protected

Definition at line 97 of file Session.php.

◆ $_isCustomerIdChecked

$_isCustomerIdChecked = null

protected

Definition at line 48 of file Session.php.

◆ $_session

$_session

protected

Definition at line 72 of file Session.php.

◆ $_urlFactory

$_urlFactory

protected

Definition at line 87 of file Session.php.

◆ $customerRepository

$customerRepository

protected

Definition at line 77 of file Session.php.

◆ $groupManagement

$groupManagement

protected

Definition at line 102 of file Session.php.

◆ $response

$response

protected

Definition at line 107 of file Session.php.

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

vendor/magento/module-customer/Model/Session.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _createUrl()

◆ _logout()

◆ _setAuthUrl()

◆ authenticate()

◆ checkCustomerId()

◆ getCustomer()

◆ getCustomerConfigShare()

◆ getCustomerData()

◆ getCustomerDataObject()

◆ getCustomerGroupId()

◆ getCustomerId()

◆ getId()

◆ isLoggedIn()

◆ loginById()

◆ logout()

◆ regenerateId()

◆ setAfterAuthUrl()

◆ setBeforeAuthUrl()

◆ setCustomer()

◆ setCustomerAsLoggedIn()

◆ setCustomerData()

◆ setCustomerDataAsLoggedIn()

◆ setCustomerDataObject()

◆ setCustomerGroupId()

◆ setCustomerId()

◆ setId()

Field Documentation

◆ $_configShare

◆ $_coreUrl

◆ $_customer

◆ $_customerFactory

◆ $_customerModel

◆ $_customerResource

◆ $_customerUrl

◆ $_eventManager

◆ $_httpContext

◆ $_isCustomerIdChecked

◆ $_session

◆ $_urlFactory

◆ $customerRepository

◆ $groupManagement

◆ $response