forked from zendframework/zendframework
-
Notifications
You must be signed in to change notification settings - Fork 0
/
InputCollection.php
267 lines (228 loc) · 7.6 KB
/
InputCollection.php
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\InputFilter;
use IteratorIterator;
use Zend\Filter\FilterChain;
use Zend\InputFilter\Result\ValidationResult;
use Zend\InputFilter\ValidationGroup\FilterIteratorInterface;
use Zend\InputFilter\ValidationGroup\NoOpFilterIterator;
use Zend\Validator\ValidatorChain;
/**
* Input collection class
*/
class InputCollection extends Input implements InputCollectionInterface
{
/**
* @var Factory
*/
protected $factory;
/**
* @var InputCollectionInterface[]|InputInterface[]
*/
protected $children = array();
/**
* @var FilterIteratorInterface
*/
protected $validationGroupFilter;
/**
* @param FilterChain $filterChain
* @param ValidatorChain $validatorChain
* @param Factory $factory
*/
public function __construct(FilterChain $filterChain, ValidatorChain $validatorChain, Factory $factory)
{
parent::__construct($filterChain, $validatorChain);
$this->factory = $factory;
}
/**
* Get the input collection factory
*
* @return Factory
*/
public function getFactory()
{
return $this->factory;
}
/**
* {@inheritDoc}
*/
public function add($inputOrInputCollection, $name = null)
{
// Note: you MUST NOT check against Traversable here, because InputCollection is a Traversable itself
if (is_array($inputOrInputCollection)) {
$inputOrInputCollection = $this->factory->createFromSpecification($inputOrInputCollection);
}
if (null !== $name) {
$inputOrInputCollection->setName($name);
}
$this->children[$inputOrInputCollection->getName()] = $inputOrInputCollection;
}
/**
* {@inheritDoc}
*/
public function get($name)
{
if (!isset($this->children[$name])) {
throw new Exception\RuntimeException(sprintf(
'No input or input collection named "%s" was found in input collection of type "%s" with the name "%s"',
$name,
__CLASS__,
$this->getName()
));
}
return $this->children[$name];
}
/**
* {@inheritDoc}
*/
public function has($name)
{
return isset($this->children[$name]);
}
/**
* {@inheritDoc}
*/
public function remove($name)
{
unset($this->children[$name]);
}
/**
* Set a validation group filter
*
* @param FilterIteratorInterface $validationGroupFilter
* @throws Exception\RuntimeException
* @return void
*/
public function setValidationGroupFilter(FilterIteratorInterface $validationGroupFilter)
{
$this->validationGroupFilter = $validationGroupFilter;
}
/**
* Get the validation group filter
*
* @return FilterIteratorInterface
*/
public function getValidationGroupFilter()
{
if (null === $this->validationGroupFilter) {
$this->validationGroupFilter = new NoOpFilterIterator($this);
}
return $this->validationGroupFilter;
}
/**
* {@inheritDoc}
*/
public function validate($data, $context = null)
{
$iterator = $this->getValidationGroupFilter();
$iteratorIterator = new IteratorIterator($iterator);
$errorMessages = array();
// As an input collection can have also validators and filters, we first apply the
// validation for itself
if (!$this->validatorChain->isValid($data, $context)) {
$errorMessages[$this->name] = $this->validatorChain->getMessages();
}
/** @var InputInterface|InputCollectionInterface $inputOrInputCollection */
foreach ($iteratorIterator as $inputOrInputCollection) {
$name = $inputOrInputCollection->getName();
$value = isset($data[$name]) ? $data[$name] : null;
if ($inputOrInputCollection instanceof InputCollectionInterface && null !== $value) {
// @TODO: in current ZF2 implementation, if an input inside a nested input filter
// @TODO is configured to break on failure, it only break from the current input filter.
// @TODO Should we throw an exception and allow to break all other inputs, even if not
// @TODO at same nested level?
$validationResult = $inputOrInputCollection->validate($value, $context);
if ($validationResult->isValid()) {
$errorMessages[$name] = $validationResult->getErrorMessages();
}
continue;
}
// Otherwise we have an input
$validationResult = $inputOrInputCollection->validate($value, $context);
if (!$validationResult->isValid()) {
$errorMessages[$name] = $validationResult->getErrorMessages();
if ($inputOrInputCollection->breakOnFailure()) {
break;
}
}
}
return $this->buildValidationResult($data, $errorMessages);
}
/**
* Build a validation result from the raw data and error messages
*
* By default, this method assumes that if there are NO ERRORS in the given
* input collection (ie. all inputs have passed validation), then the data
* are filtered. Otherwise, they are not
*
* @param array $rawData
* @param array $errorMessages
* @return Result\ValidationResultInterface
*/
protected function buildValidationResult(array $rawData, array $errorMessages)
{
if (!empty($errorMessages)) {
return new ValidationResult($rawData, null, $errorMessages);
}
// Otherwise, we filter data only for the given input collection
$iterator = $this->getValidationGroupFilter();
$iteratorIterator = new IteratorIterator($iterator);
$filteredData = array();
/** @var InputInterface|InputCollectionInterface $inputOrInputCollection */
foreach ($iteratorIterator as $inputOrInputCollection) {
$name = $inputOrInputCollection->getName();
$data = isset($rawData[$name]) ? $rawData[$name] : null;
$filteredData[$name] = $inputOrInputCollection->getFilterChain()->filter($data);
}
// As an input collection can also contain filters, we finally filter the data
// using the input collection filters
$this->filterChain->filter($filteredData);
return new ValidationResult($rawData, $filteredData, $errorMessages);
}
/**
* --------------------------------------------------------------------------------
* Implementation of Iterator interface
* --------------------------------------------------------------------------------
*/
/**
* {@inheritDoc}
*/
public function current()
{
return current($this->children);
}
/**
* {@inheritDoc}
*/
public function next()
{
next($this->children);
}
/**
* {@inheritDoc}
*/
public function key()
{
return key($this->children);
}
/**
* {@inheritDoc}
*/
public function valid()
{
return current($this->children);
}
/**
* {@inheritDoc}
*/
public function rewind()
{
reset($this->children);
}
}