Inheritance diagram for Session:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\App\Config\ScopeConfigInterface $coreConfig, \Magento\Framework\Json\Helper\Data $jsonHelper, \Magento\Persistent\Helper\Data $persistentData, \Magento\Framework\Stdlib\CookieManagerInterface $cookieManager, \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $cookieMetadataFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Math\Random $mathRandom, \Magento\Framework\Session\Config\ConfigInterface $sessionConfig, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	setLoadExpired ($loadExpired=true)

	getLoadExpired ()

	getExpiredBefore ($store=null)

	beforeSave ()

	loadByCookieKey ($key=null)

	loadByCustomerId ($id)

	deleteByCustomerId ($customerId, $clearCookie=true)

	removePersistentCookie ()

	setPersistentCookie ($duration, $path)

	renewPersistentCookie ($duration, $path)

	deleteExpired ($websiteId=null)

	afterDeleteCommit ()

	save ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	KEY_LENGTH = 50

const	COOKIE_NAME = 'persistent_shopping_cart'

Protected Member Functions
	_construct ()

	_afterLoad ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_unserializableFields

	$_loadExpired = false

	$_persistentData

	$jsonHelper

	$_coreConfig

	$_storeManager

	$_cookieManager

	$_cookieMetadataFactory

	$mathRandom

	$sessionConfig

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Persistent Session Model

@api @method int getCustomerId() @method Session setCustomerId() @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 17 of file Session.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig,
		\Magento\Framework\Json\Helper\Data	$jsonHelper,
		\Magento\Persistent\Helper\Data	$persistentData,
		\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager,
		\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Math\Random	$mathRandom,
		\Magento\Framework\Session\Config\ConfigInterface	$sessionConfig,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Constructor

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig
\Magento\Framework\Json\Helper\Data	$jsonHelper
\Magento\Persistent\Helper\Data	$persistentData
\Magento\Framework\Stdlib\CookieManagerInterface	$cookieManager
\Magento\Framework\Stdlib\Cookie\CookieMetadataFactory	$cookieMetadataFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Math\Random	$mathRandom
\Magento\Framework\Session\Config\ConfigInterface	$sessionConfig
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 125 of file Session.php.

       {
         $this->jsonHelper = $jsonHelper;
         $this->_persistentData = $persistentData;
         $this->_coreConfig = $coreConfig;
         $this->_cookieManager = $cookieManager;
         $this->_cookieMetadataFactory = $cookieMetadataFactory;
         $this->_storeManager = $storeManager;
         $this->sessionConfig = $sessionConfig;
         $this->mathRandom = $mathRandom;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _afterLoad()

_afterLoad ( )

protected

Set model data from info field

Returns: $this

Definition at line 233 of file Session.php.

     {
         parent::_afterLoad();
         $info = null;
         if ($this->getInfo()) {
             $info = $this->jsonHelper->jsonDecode($this->getInfo());
         }
         if (is_array($info)) {
             foreach ($info as $key => $value) {
                 $this->setData($key, $value);
             }
         }
         return $this;
     }

◆ _construct()

_construct ( )

protected

Define resource model

Returns: void @codeCoverageIgnore

Definition at line 157 of file Session.php.

     {
         $this->_init(\Magento\Persistent\Model\ResourceModel\Session::class);
     }

◆ afterDeleteCommit()

afterDeleteCommit ( )

Delete 'persistent' cookie

Returns: $this @codeCoverageIgnore

Definition at line 373 of file Session.php.

     {
         $this->removePersistentCookie();
         return parent::afterDeleteCommit();
     }

◆ beforeSave()

beforeSave ( )

Serialize info for Resource Model to save For new model check and set available cookie key

Returns: $this

Definition at line 204 of file Session.php.

     {
         parent::beforeSave();
 
         // Setting info
         $info = [];
         foreach ($this->getData() as $index => $value) {
             if (!in_array($index, $this->_unserializableFields)) {
                 $info[$index] = $value;
             }
         }
         $this->setInfo($this->jsonHelper->jsonEncode($info));
 
         if ($this->isObjectNew()) {
             $this->setWebsiteId($this->_storeManager->getStore()->getWebsiteId());
             // Setting cookie key
             do {
                 $this->setKey($this->mathRandom->getRandomString(self::KEY_LENGTH));
             } while (!$this->getResource()->isKeyAllowed($this->getKey()));
         }
 
         return $this;
     }

◆ deleteByCustomerId()

deleteByCustomerId	(	$customerId,
		$clearCookie = `true`
	)

Delete customer persistent session by customer id

Parameters

int	$customerId
bool	$clearCookie

Returns: $this

Definition at line 285 of file Session.php.

     {
         if ($clearCookie) {
             $this->removePersistentCookie();
         }
         $this->getResource()->deleteByCustomerId($customerId);
         return $this;
     }

◆ deleteExpired()

deleteExpired ( $websiteId = null )

Delete expired persistent sessions for the website

Parameters

null | int $websiteId

Returns: $this

Definition at line 348 of file Session.php.

     {
         if ($websiteId === null) {
             $websiteId = $this->_storeManager->getStore()->getWebsiteId();
         }
 
         $lifetime = $this->_coreConfig->getValue(
             \Magento\Persistent\Helper\Data::XML_PATH_LIFE_TIME,
             'website',
             intval($websiteId)
         );
 
         if ($lifetime) {
             $this->getResource()->deleteExpired($websiteId, gmdate('Y-m-d H:i:s', time() - $lifetime));
         }
 
         return $this;
     }

◆ getExpiredBefore()

getExpiredBefore ( $store = null )

Get date-time before which persistent session is expired

Parameters

int | string | \Magento\Store\Model\Store $store

Returns: string @codeCoverageIgnore

Definition at line 193 of file Session.php.

     {
         return gmdate('Y-m-d H:i:s', time() - $this->_persistentData->getLifeTime($store));
     }

◆ getLoadExpired()

getLoadExpired ( )

Get if model loads expired sessions

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 181 of file Session.php.

     {
         return $this->_loadExpired;
     }

◆ loadByCookieKey()

loadByCookieKey ( $key = null )

Get persistent session by cookie key

Parameters

string $key

Returns: $this

Definition at line 254 of file Session.php.

     {
         if (null === $key) {
             $key = $this->_cookieManager->getCookie(self::COOKIE_NAME);
         }
         if ($key) {
             $this->load($key, 'key');
         }
 
         return $this;
     }

◆ loadByCustomerId()

loadByCustomerId ( $id )

Load session model by specified customer id

Parameters

int $id

Returns: $this @codeCoverageIgnore

Definition at line 273 of file Session.php.

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

◆ removePersistentCookie()

removePersistentCookie ( )

Remove persistent cookie

Returns: $this @api

Definition at line 300 of file Session.php.

     {
         $cookieMetadata = $this->_cookieMetadataFactory->createSensitiveCookieMetadata()
             ->setPath($this->sessionConfig->getCookiePath());
         $this->_cookieManager->deleteCookie(self::COOKIE_NAME, $cookieMetadata);
         return $this;
     }

◆ renewPersistentCookie()

renewPersistentCookie	(	$duration,
		$path
	)

Postpone cookie expiration time if cookie value defined

Parameters

int	$duration	Time in seconds.
string	$path

Returns: $this

Definition at line 330 of file Session.php.

     {
         if ($duration === null) {
             return $this;
         }
         $value = $this->_cookieManager->getCookie(self::COOKIE_NAME);
         if (null !== $value) {
             $this->setCookie($value, $duration, $path);
         }
         return $this;
     }

◆ save()

save ( )

Set updated_at to be always changed

Returns: $this

Since: 100.1.0

Definition at line 422 of file Session.php.

     {
         $this->setUpdatedAt(gmdate('Y-m-d H:i:s'));
         return parent::save();
     }

◆ setLoadExpired()

setLoadExpired ( $loadExpired = true )

Set if load expired persistent session

Parameters

bool $loadExpired

Returns: $this @codeCoverageIgnore

Definition at line 169 of file Session.php.

     {
         $this->_loadExpired = $loadExpired;
         return $this;
     }

◆ setPersistentCookie()

setPersistentCookie	(	$duration,
		$path
	)

Set persistent cookie

Parameters

int	$duration	Time in seconds.
string	$path

Returns: $this @api

Definition at line 316 of file Session.php.

     {
         $value = $this->getKey();
         $this->setCookie($value, $duration, $path);
         return $this;
     }

Field Documentation

◆ $_cookieManager

$_cookieManager

protected

Definition at line 81 of file Session.php.

◆ $_cookieMetadataFactory

$_cookieMetadataFactory

protected

Definition at line 88 of file Session.php.

◆ $_coreConfig

$_coreConfig

protected

Definition at line 67 of file Session.php.

◆ $_loadExpired

$_loadExpired = false

protected

Definition at line 48 of file Session.php.

◆ $_persistentData

$_persistentData

protected

Definition at line 55 of file Session.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 74 of file Session.php.

◆ $_unserializableFields

$_unserializableFields

protected

Initial value:

= [
        'persistent_id',
        'key',
        'customer_id',
        'website_id',
        'info',
        'updated_at',
    ]

Definition at line 34 of file Session.php.

◆ $jsonHelper

$jsonHelper

protected

Definition at line 62 of file Session.php.

◆ $mathRandom

$mathRandom

protected

Definition at line 93 of file Session.php.

◆ $sessionConfig

$sessionConfig

protected

Definition at line 98 of file Session.php.

◆ COOKIE_NAME

const COOKIE_NAME = 'persistent_shopping_cart'

Persistent cookie name

Definition at line 27 of file Session.php.

◆ KEY_LENGTH

const KEY_LENGTH = 50

Persistent cookie key length

Definition at line 22 of file Session.php.

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

vendor/magento/module-persistent/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

◆ _afterLoad()

◆ _construct()

◆ afterDeleteCommit()

◆ beforeSave()

◆ deleteByCustomerId()

◆ deleteExpired()

◆ getExpiredBefore()

◆ getLoadExpired()

◆ loadByCookieKey()

◆ loadByCustomerId()

◆ removePersistentCookie()

◆ renewPersistentCookie()

◆ save()

◆ setLoadExpired()

◆ setPersistentCookie()

Field Documentation

◆ $_cookieManager

◆ $_cookieMetadataFactory

◆ $_coreConfig

◆ $_loadExpired

◆ $_persistentData

◆ $_storeManager

◆ $_unserializableFields

◆ $jsonHelper

◆ $mathRandom

◆ $sessionConfig

◆ COOKIE_NAME

◆ KEY_LENGTH