Public Member Functions
	__construct (\Magento\Framework\Stdlib\Cookie\PhpCookieManager $phpCookieManager, \Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory $cookieMetadataFactory, CookieReaderInterface $cookieReader, \Magento\Backend\Helper\Data $backendData)

	getLogoutReasonCookie ()

	setLogoutReasonCookie ($status)

	deleteLogoutReasonCookie ()

Data Fields
const	LOGOUT_REASON_CODE_COOKIE_NAME = 'loggedOutReasonCode'

Detailed Description

Manager for a cookie with logout reason

@api

Since: 100.1.0

Definition at line 16 of file SecurityCookie.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Stdlib\Cookie\PhpCookieManager	$phpCookieManager,
		\Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory	$cookieMetadataFactory,
		CookieReaderInterface	$cookieReader,
		\Magento\Backend\Helper\Data	$backendData
	)

Parameters

\Magento\Framework\Stdlib\Cookie\PhpCookieManager	$phpCookieManager
\Magento\Framework\Stdlib\Cookie\PublicCookieMetadataFactory	$cookieMetadataFactory
CookieReaderInterface	$cookieReader
\Magento\Backend\Helper\Data	$backendData

Definition at line 49 of file SecurityCookie.php.

       {
         $this->phpCookieManager = $phpCookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->cookieReader = $cookieReader;
         $this->backendData = $backendData;
     }

Member Function Documentation

◆ deleteLogoutReasonCookie()

deleteLogoutReasonCookie ( )

Delete cookie with reason of logout

Returns: $this

Since: 100.1.0

Definition at line 99 of file SecurityCookie.php.

     {
         $metaData = $this->createCookieMetaData();
         $metaData->setPath('/' . $this->backendData->getAreaFrontName())->setDuration(-1);
 
         $this->phpCookieManager->setPublicCookie(
             self::LOGOUT_REASON_CODE_COOKIE_NAME,
             '',
             $metaData
         );
 
         return $this;
     }

◆ getLogoutReasonCookie()

getLogoutReasonCookie ( )

Get cookie with logout reason code

Returns: string|int

Since: 100.1.0

Definition at line 67 of file SecurityCookie.php.

     {
         return (int) $this->cookieReader->getCookie(self::LOGOUT_REASON_CODE_COOKIE_NAME, -1);
     }

◆ setLogoutReasonCookie()

setLogoutReasonCookie ( $status )

Set logout reason cookie

Parameters

int $status

Returns: $this

Since: 100.1.0

Definition at line 79 of file SecurityCookie.php.

     {
         $metaData = $this->createCookieMetaData();
         $metaData->setPath('/' . $this->backendData->getAreaFrontName());
 
         $this->phpCookieManager->setPublicCookie(
             self::LOGOUT_REASON_CODE_COOKIE_NAME,
             (int) $status,
             $metaData
         );
 
         return $this;
     }

Field Documentation

◆ LOGOUT_REASON_CODE_COOKIE_NAME

const LOGOUT_REASON_CODE_COOKIE_NAME = 'loggedOutReasonCode'

Cookie name

Definition at line 21 of file SecurityCookie.php.

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

vendor/magento/module-security/Model/SecurityCookie.php

Public Member Functions

Data Fields