FormKey Class Reference

Public Member Functions
	__construct (CookieManagerInterface $cookieManager, CookieMetadataFactory $cookieMetadataFactory, SessionManagerInterface $sessionManager)
	get ()
	set ($value, PublicCookieMetadata $metadata)
	delete ()

Data Fields
const	COOKIE_NAME = 'form_key'

Detailed Description

Class Version

Definition at line 17 of file FormKey.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CookieManagerInterface	$cookieManager,
		CookieMetadataFactory	$cookieMetadataFactory,
		SessionManagerInterface	$sessionManager
	)

Parameters

CookieManagerInterface	$cookieManager
CookieMetadataFactory	$cookieMetadataFactory
SessionManagerInterface	$sessionManager

Definition at line 46 of file FormKey.php.

      {
        $this->cookieManager = $cookieManager;
        $this->cookieMetadataFactory = $cookieMetadataFactory;
        $this->sessionManager = $sessionManager;
    }

Member Function Documentation

delete()

delete

(

)

Returns

void

Definition at line 83 of file FormKey.php.

    {
        $this->cookieManager->deleteCookie(
            self::COOKIE_NAME,
            $this->cookieMetadataFactory
                ->createCookieMetadata()
                ->setPath($this->sessionManager->getCookiePath())
                ->setDomain($this->sessionManager->getCookieDomain())
        );
    }

get()

get

(

)

Get form key cookie

Returns

string

Definition at line 61 of file FormKey.php.

    {
        return $this->cookieManager->getCookie(self::COOKIE_NAME);
    }

set()

set	(		$value,
		PublicCookieMetadata	$metadata
	)

Parameters

string	$value
PublicCookieMetadata	$metadata

Returns

void

Definition at line 71 of file FormKey.php.

    {
        $this->cookieManager->setPublicCookie(
            self::COOKIE_NAME,
            $value,
            $metadata
        );
    }

Field Documentation

COOKIE_NAME

const COOKIE_NAME = 'form_key'

Name of cookie that holds private content version

Definition at line 22 of file FormKey.php.

---

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

• vendor/magento/framework/App/PageCache/FormKey.php