Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Module\Dir\Reader $modulesReader, \Magento\Framework\Escaper $escaper)
	isEnabled ($store=null)
	isRememberMeEnabled ($store=null)
	isRememberMeCheckedDefault ($store=null)
	isShoppingCartPersist ($store=null)
	getLifeTime ($store=null)
	getClearOnLogout ()
	getUnsetCookieUrl ()
	getPersistentConfigFilePath ()
	canProcess ($observer)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_ENABLED = 'persistent/options/enabled'
const	XML_PATH_LIFE_TIME = 'persistent/options/lifetime'
const	XML_PATH_LOGOUT_CLEAR = 'persistent/options/logout_clear'
const	XML_PATH_REMEMBER_ME_ENABLED = 'persistent/options/remember_enabled'
const	XML_PATH_REMEMBER_ME_DEFAULT = 'persistent/options/remember_default'
const	XML_PATH_PERSIST_SHOPPING_CART = 'persistent/options/shopping_cart'

Protected Attributes
	$_configFileName = 'persistent.xml'
	$_escaper
	$_modulesReader
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

@api

Since

100.0.2

Definition at line 19 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Module\Dir\Reader	$modulesReader,
		\Magento\Framework\Escaper	$escaper
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Module\Dir\Reader	$modulesReader
\Magento\Framework\Escaper	$escaper

Definition at line 55 of file Data.php.

      {
        $this->_modulesReader = $modulesReader;
        $this->_escaper = $escaper;
        parent::__construct(
            $context
        );
    }

Member Function Documentation

canProcess()

canProcess

(

$observer

)

Check whether specified action should be processed

Parameters

\Magento\Framework\Event\Observer

$observer

Returns

bool @SuppressWarnings(PHPMD.UnusedFormalParameter) @codeCoverageIgnore

Definition at line 194 of file Data.php.

    {
        return true;
    }

getClearOnLogout()

getClearOnLogout

(

)

Check if set Clear on Logout in config settings

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName) @codeCoverageIgnore

Definition at line 156 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_LOGOUT_CLEAR,
            ScopeInterface::SCOPE_STORE
        );
    }

getLifeTime()

getLifeTime

(

$store = null

)

Get Persistence Lifetime

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

int

Definition at line 137 of file Data.php.

    {
        $lifeTime = intval(
            $this->scopeConfig->getValue(
                self::XML_PATH_LIFE_TIME,
                ScopeInterface::SCOPE_STORE,
                $store
            )
        );
        return $lifeTime < 0 ? 0 : $lifeTime;
    }

getPersistentConfigFilePath()

getPersistentConfigFilePath

(

)

Retrieve path for config file

Returns

string

Definition at line 180 of file Data.php.

    {
        return $this->_modulesReader->getModuleDir(Dir::MODULE_ETC_DIR, $this->_getModuleName())
        . '/' . $this->_configFileName;
    }

getUnsetCookieUrl()

getUnsetCookieUrl

(

)

Retrieve url for unset long-term cookie

Returns

string @codeCoverageIgnore

Definition at line 170 of file Data.php.

    {
        return $this->_getUrl('persistent/index/unsetCookie');
    }

isEnabled()

isEnabled

(

$store = null

)

Checks whether Persistence Functionality is enabled

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

bool @codeCoverageIgnore

Definition at line 74 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_ENABLED,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

isRememberMeCheckedDefault()

isRememberMeCheckedDefault

(

$store = null

)

Is "Remember Me" checked by default

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

bool @codeCoverageIgnore

Definition at line 106 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_REMEMBER_ME_DEFAULT,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

isRememberMeEnabled()

isRememberMeEnabled

(

$store = null

)

Checks whether "Remember Me" enabled

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

bool @codeCoverageIgnore

Definition at line 90 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_REMEMBER_ME_ENABLED,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

isShoppingCartPersist()

isShoppingCartPersist

(

$store = null

)

Is shopping cart persist

Parameters

int | string | \Magento\Store\Model\Store

$store

Returns

bool @codeCoverageIgnore

Definition at line 122 of file Data.php.

    {
        return $this->scopeConfig->isSetFlag(
            self::XML_PATH_PERSIST_SHOPPING_CART,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

Field Documentation

$_configFileName

$_configFileName = 'persistent.xml'

protected

Definition at line 38 of file Data.php.

$_escaper

$_escaper

protected

Definition at line 43 of file Data.php.

$_modulesReader

$_modulesReader

protected

Definition at line 48 of file Data.php.

XML_PATH_ENABLED

const XML_PATH_ENABLED = 'persistent/options/enabled'

Definition at line 21 of file Data.php.

XML_PATH_LIFE_TIME

const XML_PATH_LIFE_TIME = 'persistent/options/lifetime'

Definition at line 23 of file Data.php.

XML_PATH_LOGOUT_CLEAR

const XML_PATH_LOGOUT_CLEAR = 'persistent/options/logout_clear'

Definition at line 25 of file Data.php.

XML_PATH_PERSIST_SHOPPING_CART

const XML_PATH_PERSIST_SHOPPING_CART = 'persistent/options/shopping_cart'

Definition at line 31 of file Data.php.

XML_PATH_REMEMBER_ME_DEFAULT

const XML_PATH_REMEMBER_ME_DEFAULT = 'persistent/options/remember_default'

Definition at line 29 of file Data.php.

XML_PATH_REMEMBER_ME_ENABLED

const XML_PATH_REMEMBER_ME_ENABLED = 'persistent/options/remember_enabled'

Definition at line 27 of file Data.php.

---

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

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