Cookie Class Reference

Inheritance diagram for Cookie:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, array $data=[])
	isUserNotAllowSaveCookie ()
	isCookieRestrictionModeEnabled ()
	getAcceptedSaveCookiesWebsiteIds ()
	getCookieRestrictionLifetime ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	IS_USER_ALLOWED_SAVE_COOKIE = 'user_allowed_save_cookie'
const	XML_PATH_COOKIE_RESTRICTION = 'web/cookie/cookie_restriction'
const	XML_PATH_COOKIE_RESTRICTION_LIFETIME = 'web/cookie/cookie_restriction_lifetime'

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

Protected Attributes
	$_currentStore
	$_website
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Cookie helper @api

Since

100.0.2

Definition at line 13 of file Cookie.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		array	$data = []
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
array	$data

Exceptions

Definition at line 47 of file Cookie.php.

      {
        parent::__construct($context);
        $this->_currentStore = isset($data['current_store']) ? $data['current_store'] : $storeManager->getStore();

        if (!$this->_currentStore instanceof \Magento\Store\Model\Store) {
            throw new \InvalidArgumentException('Required store object is invalid');
        }

        $this->_website = isset($data['website']) ? $data['website'] : $storeManager->getWebsite();

        if (!$this->_website instanceof \Magento\Store\Model\Website) {
            throw new \InvalidArgumentException('Required website object is invalid');
        }
    }

Member Function Documentation

_getAcceptedSaveCookiesWebsites()

_getAcceptedSaveCookiesWebsites ( )

protected

Get accepted save cookies websites

Returns

array

Definition at line 110 of file Cookie.php.

    {
        $unSerializedList = null;
        $serializedList = $this->_request->getCookie(self::IS_USER_ALLOWED_SAVE_COOKIE, false);
        if ($serializedList) {
            $unSerializedList = json_decode($serializedList, true);
        }
        return is_array($unSerializedList) ? $unSerializedList : [];
    }

getAcceptedSaveCookiesWebsiteIds()

getAcceptedSaveCookiesWebsiteIds

(

)

Return serialized list of accepted save cookie website

Returns

string

Definition at line 98 of file Cookie.php.

    {
        $acceptedSaveCookiesWebsites = $this->_getAcceptedSaveCookiesWebsites();
        $acceptedSaveCookiesWebsites[(int)$this->_website->getId()] = 1;
        return json_encode($acceptedSaveCookiesWebsites);
    }

getCookieRestrictionLifetime()

getCookieRestrictionLifetime

(

)

Get cookie restriction lifetime (in seconds)

Returns

int

Definition at line 125 of file Cookie.php.

    {
        return (int)$this->scopeConfig->getValue(
            self::XML_PATH_COOKIE_RESTRICTION_LIFETIME,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $this->_currentStore
        );
    }

isCookieRestrictionModeEnabled()

isCookieRestrictionModeEnabled

(

)

Check if cookie restriction mode is enabled for this store

Returns

bool

Since

100.1.3

Definition at line 84 of file Cookie.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_COOKIE_RESTRICTION,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $this->_currentStore
        );
    }

isUserNotAllowSaveCookie()

isUserNotAllowSaveCookie

(

)

Check if cookie restriction notice should be displayed

Returns

bool

Definition at line 71 of file Cookie.php.

    {
        $acceptedSaveCookiesWebsites = $this->_getAcceptedSaveCookiesWebsites();
        return $this->isCookieRestrictionModeEnabled() &&
            empty($acceptedSaveCookiesWebsites[$this->_website->getId()]);
    }

Field Documentation

$_currentStore

$_currentStore

protected

Definition at line 33 of file Cookie.php.

$_website

$_website

protected

Definition at line 38 of file Cookie.php.

IS_USER_ALLOWED_SAVE_COOKIE

const IS_USER_ALLOWED_SAVE_COOKIE = 'user_allowed_save_cookie'

Cookie name for users who allowed cookie save

Definition at line 18 of file Cookie.php.

XML_PATH_COOKIE_RESTRICTION

const XML_PATH_COOKIE_RESTRICTION = 'web/cookie/cookie_restriction'

Path to configuration, check is enable cookie restriction mode

Definition at line 23 of file Cookie.php.

XML_PATH_COOKIE_RESTRICTION_LIFETIME

const XML_PATH_COOKIE_RESTRICTION_LIFETIME = 'web/cookie/cookie_restriction_lifetime'

Cookie restriction lifetime configuration path

Definition at line 28 of file Cookie.php.

---

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

• vendor/magento/module-cookie/Helper/Cookie.php