FormKey Class Reference

Public Member Functions
	__construct (\Magento\Framework\Math\Random $mathRandom, \Magento\Framework\Session\SessionManagerInterface $session, \Magento\Framework\Escaper $escaper)
	getFormKey ()
	isPresent ()
	set ($value)

Data Fields
const	FORM_KEY = '_form_key'

Protected Attributes
	$mathRandom
	$session
	$escaper

Detailed Description

@api

Since

100.0.2

Definition at line 12 of file FormKey.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Math\Random	$mathRandom,
		\Magento\Framework\Session\SessionManagerInterface	$session,
		\Magento\Framework\Escaper	$escaper
	)

Parameters

\Magento\Framework\Math\Random	$mathRandom
\Magento\Framework\Session\SessionManagerInterface	$session
\Magento\Framework\Escaper	$escaper

Definition at line 40 of file FormKey.php.

      {
        $this->mathRandom = $mathRandom;
        $this->session = $session;
        $this->escaper = $escaper;
    }

Member Function Documentation

getFormKey()

getFormKey

(

)

Retrieve Session Form Key

Returns

string A 16 bit unique key for forms

Definition at line 55 of file FormKey.php.

    {
        if (!$this->isPresent()) {
            $this->set($this->mathRandom->getRandomString(16));
        }
        return $this->escaper->escapeHtmlAttr($this->session->getData(self::FORM_KEY));
    }

isPresent()

isPresent

(

)

Returns

bool

Definition at line 66 of file FormKey.php.

    {
        return (bool)$this->session->getData(self::FORM_KEY);
    }

set()

set

(

$value

)

Parameters

string

$value

Returns

void

Definition at line 75 of file FormKey.php.

    {
        $this->session->setData(self::FORM_KEY, $value);
    }

Field Documentation

$escaper

$escaper

protected

Definition at line 33 of file FormKey.php.

$mathRandom

$mathRandom

protected

Definition at line 22 of file FormKey.php.

$session

$session

protected

Definition at line 27 of file FormKey.php.

FORM_KEY

const FORM_KEY = '_form_key'

Form key

Definition at line 17 of file FormKey.php.

---

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

• vendor/magento/framework/Data/Form/FormKey.php