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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\Element;
use Zend\Form\Element;
use Zend\Form\ElementPrepareAwareInterface;
use Zend\Form\FormInterface;
use Zend\InputFilter\InputProviderInterface;
use Zend\Validator\Csrf as CsrfValidator;
class Csrf extends Element implements InputProviderInterface, ElementPrepareAwareInterface
{
/**
* Seed attributes
*
* @var array
*/
protected $attributes = [
'type' => 'hidden',
];
/**
* @var array
*/
protected $csrfValidatorOptions = [];
/**
* @var CsrfValidator
*/
protected $csrfValidator;
/**
* Accepted options for Csrf:
* - csrf_options: an array used in the Csrf
*
* @param array|\Traversable $options
* @return Csrf
*/
public function setOptions($options)
{
parent::setOptions($options);
if (isset($options['csrf_options'])) {
$this->setCsrfValidatorOptions($options['csrf_options']);
}
return $this;
}
/**
* @return array
*/
public function getCsrfValidatorOptions()
{
return $this->csrfValidatorOptions;
}
/**
* @param array $options
* @return Csrf
*/
public function setCsrfValidatorOptions(array $options)
{
$this->csrfValidatorOptions = $options;
return $this;
}
/**
* Get CSRF validator
*
* @return CsrfValidator
*/
public function getCsrfValidator()
{
if (null === $this->csrfValidator) {
$csrfOptions = $this->getCsrfValidatorOptions();
$csrfOptions = array_merge($csrfOptions, ['name' => $this->getName()]);
$this->setCsrfValidator(new CsrfValidator($csrfOptions));
}
return $this->csrfValidator;
}
/**
* @param \Zend\Validator\Csrf $validator
* @return Csrf
*/
public function setCsrfValidator(CsrfValidator $validator)
{
$this->csrfValidator = $validator;
return $this;
}
/**
* Retrieve value
*
* Retrieves the hash from the validator
*
* @return string
*/
public function getValue()
{
$validator = $this->getCsrfValidator();
return $validator->getHash();
}
/**
* Override: get attributes
*
* Seeds 'value' attribute with validator hash
*
* @return array
*/
public function getAttributes()
{
$attributes = parent::getAttributes();
$validator = $this->getCsrfValidator();
$attributes['value'] = $validator->getHash();
return $attributes;
}
/**
* Provide default input rules for this element
*
* Attaches the captcha as a validator.
*
* @return array
*/
public function getInputSpecification()
{
return [
'name' => $this->getName(),
'required' => true,
'filters' => [
['name' => 'Zend\Filter\StringTrim'],
],
'validators' => [
$this->getCsrfValidator(),
],
];
}
/**
* Prepare the form element
*/
public function prepareElement(FormInterface $form)
{
$this->getCsrfValidator()->getHash(true);
}
}