FormKey.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Data\Form;

class FormKey
{
    const FORM_KEY = '_form_key';

    protected $mathRandom;

    protected $session;

    protected $escaper;

    public function __construct(
        \Magento\Framework\Math\Random $mathRandom,
        \Magento\Framework\Session\SessionManagerInterface $session,
        \Magento\Framework\Escaper $escaper
    ) {
        $this->mathRandom = $mathRandom;
        $this->session = $session;
        $this->escaper = $escaper;
    }

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

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

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