Session Class Reference

Inheritance diagram for Session:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Persistent\Helper\Data $persistentData, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Persistent\Model\SessionFactory $sessionFactory)
	getSession ()
	setSession ($sessionModel)
	isPersistent ()
	isRememberMeChecked ()
	setRememberMeChecked ($checked=true)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$_sessionModel
	$_isRememberMeChecked
	$_persistentData
	$_sessionFactory
	$_checkoutSession
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Persistent Shopping Cart Data Helper

@api

Since

100.0.2

Definition at line 14 of file Session.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Persistent\Helper\Data	$persistentData,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Persistent\Model\SessionFactory	$sessionFactory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
Data	$persistentData
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Persistent\Model\SessionFactory	$sessionFactory

Definition at line 57 of file Session.php.

      {
        $this->_persistentData = $persistentData;
        $this->_checkoutSession = $checkoutSession;
        $this->_sessionFactory = $sessionFactory;

        parent::__construct(
            $context
        );
    }

Member Function Documentation

getSession()

getSession

(

)

Get Session model

Returns

\Magento\Persistent\Model\Session

Definition at line 77 of file Session.php.

    {
        if ($this->_sessionModel === null) {
            $this->_sessionModel = $this->_sessionFactory->create();
            $this->_sessionModel->loadByCookieKey();
        }
        return $this->_sessionModel;
    }

isPersistent()

isPersistent

(

)

Check whether persistent mode is running

Returns

bool

Definition at line 104 of file Session.php.

    {
        return $this->getSession()->getId() && $this->_persistentData->isEnabled();
    }

isRememberMeChecked()

isRememberMeChecked

(

)

Check if "Remember Me" checked

Returns

bool

Definition at line 114 of file Session.php.

    {
        if ($this->_isRememberMeChecked === null) {
            //Try to get from checkout session
            $isRememberMeChecked = $this->_checkoutSession->getRememberMeChecked();
            if ($isRememberMeChecked !== null) {
                $this->_isRememberMeChecked = $isRememberMeChecked;
                $this->_checkoutSession->unsRememberMeChecked();
                return $isRememberMeChecked;
            }

            return $this->_persistentData->isEnabled()
                && $this->_persistentData->isRememberMeEnabled()
                && $this->_persistentData->isRememberMeCheckedDefault();
        }

        return (bool)$this->_isRememberMeChecked;
    }

setRememberMeChecked()

setRememberMeChecked

(

$checked = true

)

Set "Remember Me" checked or not

Parameters

bool

$checked

Returns

void @codeCoverageIgnore

Definition at line 140 of file Session.php.

    {
        $this->_isRememberMeChecked = $checked;
    }

setSession()

setSession

(

$sessionModel

)

Force setting session model

Parameters

\Magento\Persistent\Model\Session

$sessionModel

Returns

\Magento\Persistent\Model\Session @codeCoverageIgnore

Definition at line 93 of file Session.php.

    {
        $this->_sessionModel = $sessionModel;
        return $this->_sessionModel;
    }

Field Documentation

$_checkoutSession

$_checkoutSession

protected

Definition at line 49 of file Session.php.

$_isRememberMeChecked

$_isRememberMeChecked

protected

Definition at line 28 of file Session.php.

$_persistentData

$_persistentData

protected

Definition at line 35 of file Session.php.

$_sessionFactory

$_sessionFactory

protected

Definition at line 42 of file Session.php.

$_sessionModel

$_sessionModel

protected

Definition at line 21 of file Session.php.

---

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

• vendor/magento/module-persistent/Helper/Session.php