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, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Customer\Model\Session $customerSession, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Framework\HTTP\PhpEnvironment\RemoteAddress $remoteAddress, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository, QuoteIdMaskFactory $quoteIdMaskFactory, \Magento\Quote\Model\QuoteFactory $quoteFactory)

	setCustomerData ($customer)

	hasQuote ()

	setLoadInactive ($load=true)

	setQuoteId ($quoteId)

	getQuoteId ()

	loadCustomerQuote ()

	setStepData ($step, $data, $value=null)

	getStepData ($step=null, $data=null)

	clearQuote ()

	clearStorage ()

	clearHelperData ()

	resetCheckout ()

	replaceQuote ($quote)

	getLastRealOrder ()

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	CHECKOUT_STATE_BEGIN = 'begin'

Data Fields inherited from SessionManagerInterface
const	HOST_KEY = '_session_hosts'

Protected Member Functions
	_getQuoteIdKey ()

	setIsQuoteMasked ($isQuoteMasked)

	isQuoteMasked ()

Protected Member Functions inherited from SessionManager
	registerSaveHandler ()

	_addHost ()

	_getHosts ()

	_cleanHosts ()

	clearSubDomainSessionCookie ()

Protected Attributes
	$_quote

	$_customer

	$_loadInactive = false

	$_order

	$_orderFactory

	$_customerSession

	$quoteRepository

	$_remoteAddress

	$_eventManager

	$_storeManager

	$customerRepository

	$quoteIdMaskFactory

	$isQuoteMasked

	$quoteFactory

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

	$validator

	$request

	$sidResolver

	$sessionConfig

	$saveHandler

	$storage

	$cookieManager

	$cookieMetadataFactory

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

Detailed Description

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 17 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,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Framework\HTTP\PhpEnvironment\RemoteAddress	$remoteAddress,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository,
		QuoteIdMaskFactory	$quoteIdMaskFactory,
		\Magento\Quote\Model\QuoteFactory	$quoteFactory
	)

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
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Customer\Model\Session	$customerSession
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Framework\HTTP\PhpEnvironment\RemoteAddress	$remoteAddress
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository
QuoteIdMaskFactory	$quoteIdMaskFactory
\Magento\Quote\Model\QuoteFactory	$quoteFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 123 of file Session.php.

       {
         $this->_orderFactory = $orderFactory;
         $this->_customerSession = $customerSession;
         $this->quoteRepository = $quoteRepository;
         $this->_remoteAddress = $remoteAddress;
         $this->_eventManager = $eventManager;
         $this->_storeManager = $storeManager;
         $this->customerRepository = $customerRepository;
         $this->quoteIdMaskFactory = $quoteIdMaskFactory;
         $this->quoteFactory = $quoteFactory;
         parent::__construct(
             $request,
             $sidResolver,
             $sessionConfig,
             $saveHandler,
             $validator,
             $storage,
             $cookieManager,
             $cookieMetadataFactory,
             $appState
         );
     }

Member Function Documentation

◆ _getQuoteIdKey()

_getQuoteIdKey ( )

protected

Returns: string @codeCoverageIgnore

Definition at line 292 of file Session.php.

     {
         return 'quote_id_' . $this->_storeManager->getStore()->getWebsiteId();
     }

◆ clearHelperData()

clearHelperData ( )

Clear misc checkout parameters

Returns: void

Definition at line 441 of file Session.php.

     {
         $this->setRedirectUrl(null)->setLastOrderId(null)->setLastRealOrderId(null)->setAdditionalMessages(null);
     }

◆ clearQuote()

clearQuote ( )

Destroy/end a session Unset all data associated with object

Returns: $this

Definition at line 415 of file Session.php.

     {
         $this->_eventManager->dispatch('checkout_quote_destroy', ['quote' => $this->getQuote()]);
         $this->_quote = null;
         $this->setQuoteId(null);
         $this->setLastSuccessQuoteId(null);
         return $this;
     }

◆ clearStorage()

clearStorage ( )

Unset all session data and quote

Returns: $this

Implements SessionManagerInterface.

Definition at line 429 of file Session.php.

     {
         parent::clearStorage();
         $this->_quote = null;
         return $this;
     }

◆ getLastRealOrder()

getLastRealOrder ( )

Get order instance based on last order ID

Returns: \Magento\Sales\Model\Order

Definition at line 472 of file Session.php.

     {
         $orderId = $this->getLastRealOrderId();
         if ($this->_order !== null && $orderId == $this->_order->getIncrementId()) {
             return $this->_order;
         }
         $this->_order = $this->_orderFactory->create();
         if ($orderId) {
             $this->_order->loadByIncrementId($orderId);
         }
         return $this->_order;
     }

◆ getQuoteId()

getQuoteId ( )

Returns: int @codeCoverageIgnore

Definition at line 311 of file Session.php.

     {
         return $this->getData($this->_getQuoteIdKey());
     }

◆ getStepData()

getStepData	(	$step = `null`,
		$data = `null`
	)

Parameters

string \| null	$step
string \| null	$data

Returns: array|string|bool

Definition at line 391 of file Session.php.

     {
         $steps = $this->getSteps();
         if ($step === null) {
             return $steps;
         }
         if (!isset($steps[$step])) {
             return false;
         }
         if ($data === null) {
             return $steps[$step];
         }
         if (!is_string($data) || !isset($steps[$step][$data])) {
             return false;
         }
         return $steps[$step][$data];
     }

◆ hasQuote()

hasQuote ( )

Check whether current session has quote

Returns: bool @codeCoverageIgnore

Definition at line 184 of file Session.php.

     {
         return isset($this->_quote);
     }

◆ isQuoteMasked()

isQuoteMasked ( )

protected

Returns: bool|null @codeCoverageIgnore

Definition at line 522 of file Session.php.

     {
         return $this->isQuoteMasked;
     }

◆ loadCustomerQuote()

loadCustomerQuote ( )

Load data for customer quote and merge with current quote

Returns: $this

Definition at line 321 of file Session.php.

     {
         if (!$this->_customerSession->getCustomerId()) {
             return $this;
         }
 
         $this->_eventManager->dispatch('load_customer_quote_before', ['checkout_session' => $this]);
 
         try {
             $customerQuote = $this->quoteRepository->getForCustomer($this->_customerSession->getCustomerId());
         } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
             $customerQuote = $this->quoteFactory->create();
         }
         $customerQuote->setStoreId($this->_storeManager->getStore()->getId());
 
         if ($customerQuote->getId() && $this->getQuoteId() != $customerQuote->getId()) {
             if ($this->getQuoteId()) {
                 $this->quoteRepository->save(
                     $customerQuote->merge($this->getQuote())->collectTotals()
                 );
             }
 
             $this->setQuoteId($customerQuote->getId());
 
             if ($this->_quote) {
                 $this->quoteRepository->delete($this->_quote);
             }
             $this->_quote = $customerQuote;
         } else {
             $this->getQuote()->getBillingAddress();
             $this->getQuote()->getShippingAddress();
             $this->getQuote()->setCustomer($this->_customerSession->getCustomerDataObject())
                 ->setTotalsCollectedFlag(false)
                 ->collectTotals();
             $this->quoteRepository->save($this->getQuote());
         }
         return $this;
     }

◆ replaceQuote()

replaceQuote ( $quote )

Parameters

Quote $quote

Returns: $this

Definition at line 460 of file Session.php.

     {
         $this->_quote = $quote;
         $this->setQuoteId($quote->getId());
         return $this;
     }

◆ resetCheckout()

resetCheckout ( )

Returns: $this @codeCoverageIgnore

Definition at line 450 of file Session.php.

     {
         $this->setCheckoutState(self::CHECKOUT_STATE_BEGIN);
         return $this;
     }

◆ setCustomerData()

setCustomerData ( $customer )

Set customer data.

Parameters

CustomerInterface | null $customer

Returns: \Magento\Checkout\Model\Session @codeCoverageIgnore

Definition at line 172 of file Session.php.

     {
         $this->_customer = $customer;
         return $this;
     }

◆ setIsQuoteMasked()

setIsQuoteMasked ( $isQuoteMasked )

protected

Parameters

$isQuoteMasked bool

Returns: void @codeCoverageIgnore

Definition at line 513 of file Session.php.

     {
         $this->isQuoteMasked = $isQuoteMasked;
     }

◆ setLoadInactive()

setLoadInactive ( $load = true )

Set quote to be loaded even if inactive

Parameters

bool $load

Returns: $this @codeCoverageIgnore

Definition at line 196 of file Session.php.

     {
         $this->_loadInactive = $load;
         return $this;
     }

◆ setQuoteId()

setQuoteId ( $quoteId )

Parameters

int $quoteId

Returns: void @codeCoverageIgnore

Definition at line 302 of file Session.php.

     {
         $this->storage->setData($this->_getQuoteIdKey(), $quoteId);
     }

◆ setStepData()

setStepData	(	$step,
		$data,
		$value = `null`
	)

Parameters

string	$step
array \| string	$data
bool \| string \| null	$value

Returns: $this

Definition at line 366 of file Session.php.

     {
         $steps = $this->getSteps();
         if ($value === null) {
             if (is_array($data)) {
                 $steps[$step] = $data;
             }
         } else {
             if (!isset($steps[$step])) {
                 $steps[$step] = [];
             }
             if (is_string($data)) {
                 $steps[$step][$data] = $value;
             }
         }
         $this->setSteps($steps);
 
         return $this;
     }

Field Documentation

◆ $_customer

$_customer

protected

Definition at line 36 of file Session.php.

◆ $_customerSession

$_customerSession

protected

Definition at line 60 of file Session.php.

◆ $_eventManager

$_eventManager

protected

Definition at line 75 of file Session.php.

◆ $_loadInactive

$_loadInactive = false

protected

Definition at line 43 of file Session.php.

◆ $_order

$_order

protected

Definition at line 50 of file Session.php.

◆ $_orderFactory

$_orderFactory

protected

Definition at line 55 of file Session.php.

◆ $_quote

$_quote

protected

Definition at line 29 of file Session.php.

◆ $_remoteAddress

$_remoteAddress

protected

Definition at line 70 of file Session.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 80 of file Session.php.

◆ $customerRepository

$customerRepository

protected

Definition at line 85 of file Session.php.

◆ $isQuoteMasked

$isQuoteMasked

protected

Parameters

bool

Definition at line 95 of file Session.php.

◆ $quoteFactory

$quoteFactory

protected

Definition at line 100 of file Session.php.

◆ $quoteIdMaskFactory

$quoteIdMaskFactory

protected

Parameters

QuoteIdMaskFactory

Definition at line 90 of file Session.php.

◆ $quoteRepository

$quoteRepository

protected

Definition at line 65 of file Session.php.

◆ CHECKOUT_STATE_BEGIN

const CHECKOUT_STATE_BEGIN = 'begin'

Checkout state begin

Definition at line 22 of file Session.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getQuoteIdKey()

◆ clearHelperData()

◆ clearQuote()

◆ clearStorage()

◆ getLastRealOrder()

◆ getQuoteId()

◆ getStepData()

◆ hasQuote()

◆ isQuoteMasked()

◆ loadCustomerQuote()

◆ replaceQuote()

◆ resetCheckout()

◆ setCustomerData()

◆ setIsQuoteMasked()

◆ setLoadInactive()

◆ setQuoteId()

◆ setStepData()

Field Documentation

◆ $_customer

◆ $_customerSession

◆ $_eventManager

◆ $_loadInactive

◆ $_order

◆ $_orderFactory

◆ $_quote

◆ $_remoteAddress

◆ $_storeManager

◆ $customerRepository

◆ $isQuoteMasked

◆ $quoteFactory

◆ $quoteIdMaskFactory

◆ $quoteRepository

◆ CHECKOUT_STATE_BEGIN