1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Data\Form;
/**
* @api
* @since 100.0.2
*/
class FormKey
{
/**
* Form key
*/
const FORM_KEY = '_form_key';
/**
* @var \Magento\Framework\Math\Random
*/
protected $mathRandom;
/**
* @var \Magento\Framework\Session\SessionManagerInterface
*/
protected $session;
/**
* @var \Magento\Framework\Escaper
* @since 100.0.3
*/
protected $escaper;
/**
* @param \Magento\Framework\Math\Random $mathRandom
* @param \Magento\Framework\Session\SessionManagerInterface $session
* @param \Magento\Framework\Escaper $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;
}
/**
* Retrieve Session Form Key
*
* @return string A 16 bit unique key for forms
*/
public function getFormKey()
{
if (!$this->isPresent()) {
$this->set($this->mathRandom->getRandomString(16));
}
return $this->escaper->escapeHtmlAttr($this->session->getData(self::FORM_KEY));
}
/**
* @return bool
*/
public function isPresent()
{
return (bool)$this->session->getData(self::FORM_KEY);
}
/**
* @param string $value
* @return void
*/
public function set($value)
{
$this->session->setData(self::FORM_KEY, $value);
}
}