|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* This file is part of Respect/Validation. |
|
5
|
|
|
* |
|
6
|
|
|
* (c) Alexandre Gomes Gaigalas <[email protected]> |
|
7
|
|
|
* |
|
8
|
|
|
* For the full copyright and license information, please view the "LICENSE.md" |
|
9
|
|
|
* file that was distributed with this source code. |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
declare(strict_types=1); |
|
13
|
|
|
|
|
14
|
|
|
namespace Respect\Validation\Exceptions; |
|
15
|
|
|
|
|
16
|
|
|
use Exception; |
|
|
|
|
|
|
17
|
|
|
use IteratorAggregate; |
|
18
|
|
|
use RecursiveIteratorIterator; |
|
19
|
|
|
use SplObjectStorage; |
|
20
|
|
|
use function count; |
|
21
|
|
|
use function is_array; |
|
22
|
|
|
|
|
23
|
|
|
class NestedValidationException extends ValidationException implements IteratorAggregate |
|
24
|
|
|
{ |
|
25
|
|
|
/** |
|
26
|
|
|
* @var SplObjectStorage |
|
27
|
|
|
*/ |
|
28
|
|
|
private $exceptions = []; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* @param ValidationException $exception |
|
32
|
|
|
* |
|
33
|
|
|
* @return self |
|
34
|
|
|
*/ |
|
35
|
116 |
|
public function addRelated(ValidationException $exception) |
|
36
|
|
|
{ |
|
37
|
116 |
|
$this->getRelated()->attach($exception); |
|
38
|
|
|
|
|
39
|
116 |
|
return $this; |
|
40
|
|
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* @return RecursiveIteratorIterator |
|
44
|
|
|
*/ |
|
45
|
106 |
|
private function getRecursiveIterator() |
|
46
|
|
|
{ |
|
47
|
106 |
|
$exceptionIterator = new RecursiveExceptionIterator($this); |
|
48
|
106 |
|
$recursiveIteratorIterator = new RecursiveIteratorIterator( |
|
49
|
106 |
|
$exceptionIterator, |
|
50
|
106 |
|
RecursiveIteratorIterator::SELF_FIRST |
|
51
|
|
|
); |
|
52
|
|
|
|
|
53
|
106 |
|
return $recursiveIteratorIterator; |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* Returns weather an exception should be omitted or not. |
|
58
|
|
|
* |
|
59
|
|
|
* @param Exception $exception |
|
60
|
|
|
* |
|
61
|
|
|
* @return bool |
|
62
|
|
|
*/ |
|
63
|
105 |
|
private function isOmissible(Exception $exception) |
|
64
|
|
|
{ |
|
65
|
105 |
|
if (!$exception instanceof self) { |
|
66
|
99 |
|
return false; |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
11 |
|
$relatedExceptions = $exception->getRelated(); |
|
70
|
11 |
|
$relatedExceptions->rewind(); |
|
71
|
11 |
|
$childException = $relatedExceptions->current(); |
|
72
|
|
|
|
|
73
|
11 |
|
return 1 === $relatedExceptions->count() && !$childException instanceof NonOmissibleException; |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* @return SplObjectStorage |
|
78
|
|
|
*/ |
|
79
|
106 |
|
public function getIterator() |
|
80
|
|
|
{ |
|
81
|
106 |
|
$childrenExceptions = new SplObjectStorage(); |
|
82
|
|
|
|
|
83
|
106 |
|
$recursiveIteratorIterator = $this->getRecursiveIterator(); |
|
84
|
106 |
|
$exceptionIterator = $recursiveIteratorIterator->getInnerIterator(); |
|
85
|
|
|
|
|
86
|
106 |
|
$lastDepth = 0; |
|
87
|
106 |
|
$lastDepthOriginal = 0; |
|
88
|
106 |
|
$knownDepths = []; |
|
89
|
106 |
|
foreach ($recursiveIteratorIterator as $childException) { |
|
90
|
105 |
|
if ($this->isOmissible($childException)) { |
|
91
|
5 |
|
continue; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
105 |
|
$currentDepth = $lastDepth; |
|
95
|
105 |
|
$currentDepthOriginal = $recursiveIteratorIterator->getDepth() + 1; |
|
96
|
|
|
|
|
97
|
105 |
|
if (isset($knownDepths[$currentDepthOriginal])) { |
|
98
|
9 |
|
$currentDepth = $knownDepths[$currentDepthOriginal]; |
|
99
|
105 |
|
} elseif ($currentDepthOriginal > $lastDepthOriginal |
|
100
|
105 |
|
&& ($this->hasCustomTemplate() || 1 != $exceptionIterator->count())) { |
|
|
|
|
|
|
101
|
10 |
|
++$currentDepth; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
105 |
|
if (!isset($knownDepths[$currentDepthOriginal])) { |
|
105
|
105 |
|
$knownDepths[$currentDepthOriginal] = $currentDepth; |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
105 |
|
$lastDepth = $currentDepth; |
|
109
|
105 |
|
$lastDepthOriginal = $currentDepthOriginal; |
|
110
|
|
|
|
|
111
|
105 |
|
$childrenExceptions->attach( |
|
112
|
105 |
|
$childException, |
|
113
|
|
|
[ |
|
114
|
105 |
|
'depth' => $currentDepth, |
|
115
|
105 |
|
'depth_original' => $currentDepthOriginal, |
|
116
|
105 |
|
'previous_depth' => $lastDepth, |
|
117
|
105 |
|
'previous_depth_original' => $lastDepthOriginal, |
|
118
|
|
|
] |
|
119
|
|
|
); |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
106 |
|
return $childrenExceptions; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
5 |
|
public function getMessages(array $templates = []): array |
|
126
|
|
|
{ |
|
127
|
5 |
|
$messages = [$this->getId() => $this->renderMessage($this, $this->getId(), $templates)]; |
|
128
|
5 |
|
foreach ($this->getRelated() as $exception) { |
|
129
|
5 |
|
$id = $exception->getId(); |
|
130
|
5 |
|
if (!$exception instanceof self) { |
|
131
|
5 |
|
$messages[$id] = $this->renderMessage( |
|
132
|
5 |
|
$exception, |
|
133
|
5 |
|
$id, |
|
134
|
5 |
|
$this->findTemplates($templates, $this->getId()) |
|
135
|
|
|
); |
|
136
|
5 |
|
continue; |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
4 |
|
$messages[$id] = $exception->getMessages($this->findTemplates($templates, $id, $this->getId())); |
|
140
|
4 |
|
if (count($messages[$id]) > 1) { |
|
|
|
|
|
|
141
|
2 |
|
continue; |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
4 |
|
$messages[$id] = current($messages[$exception->getId()]); |
|
|
|
|
|
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
5 |
|
if (count($messages) > 1) { |
|
148
|
5 |
|
unset($messages[$this->getId()]); |
|
149
|
|
|
} |
|
150
|
|
|
|
|
151
|
5 |
|
return $messages; |
|
152
|
|
|
} |
|
153
|
|
|
|
|
154
|
|
|
/** |
|
155
|
|
|
* @return string |
|
156
|
|
|
*/ |
|
157
|
106 |
|
public function getFullMessage() |
|
158
|
|
|
{ |
|
159
|
106 |
|
$marker = '-'; |
|
160
|
106 |
|
$messages = []; |
|
161
|
106 |
|
$exceptions = $this->getIterator(); |
|
162
|
|
|
|
|
163
|
106 |
|
if ($this->hasCustomTemplate() || 1 != count($exceptions)) { |
|
164
|
11 |
|
$messages[] = sprintf('%s %s', $marker, $this->getMessage()); |
|
165
|
|
|
} |
|
166
|
|
|
|
|
167
|
106 |
|
foreach ($exceptions as $exception) { |
|
168
|
105 |
|
$depth = $exceptions[$exception]['depth']; |
|
169
|
105 |
|
$prefix = str_repeat(' ', $depth * 2); |
|
170
|
105 |
|
$messages[] = sprintf('%s%s %s', $prefix, $marker, $exception->getMessage()); |
|
171
|
|
|
} |
|
172
|
|
|
|
|
173
|
106 |
|
return implode(PHP_EOL, $messages); |
|
174
|
|
|
} |
|
175
|
|
|
|
|
176
|
|
|
/** |
|
177
|
|
|
* @return SplObjectStorage |
|
178
|
|
|
*/ |
|
179
|
117 |
|
public function getRelated() |
|
180
|
|
|
{ |
|
181
|
117 |
|
if (!$this->exceptions instanceof SplObjectStorage) { |
|
|
|
|
|
|
182
|
117 |
|
$this->exceptions = new SplObjectStorage(); |
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
117 |
|
return $this->exceptions; |
|
186
|
|
|
} |
|
187
|
|
|
|
|
188
|
|
|
/** |
|
189
|
|
|
* @param array $exceptions |
|
190
|
|
|
* |
|
191
|
|
|
* @return self |
|
192
|
|
|
*/ |
|
193
|
114 |
|
public function setRelated(array $exceptions) |
|
194
|
|
|
{ |
|
195
|
114 |
|
foreach ($exceptions as $exception) { |
|
196
|
114 |
|
$this->addRelated($exception); |
|
197
|
|
|
} |
|
198
|
|
|
|
|
199
|
114 |
|
return $this; |
|
200
|
|
|
} |
|
201
|
|
|
|
|
202
|
5 |
|
private function renderMessage(ValidationException $exception, $id, array $templates): string |
|
203
|
|
|
{ |
|
204
|
5 |
|
if (isset($templates[$id])) { |
|
205
|
1 |
|
$exception->updateTemplate($templates[$id]); |
|
206
|
|
|
} |
|
207
|
|
|
|
|
208
|
5 |
|
return $exception->getMessage(); |
|
209
|
|
|
} |
|
210
|
|
|
|
|
211
|
5 |
|
private function findTemplates(array $templates, ...$ids): array |
|
212
|
|
|
{ |
|
213
|
5 |
|
while (count($ids) > 0) { |
|
214
|
5 |
|
$id = array_shift($ids); |
|
215
|
5 |
|
if (isset($templates[$id]) && is_array($templates[$id])) { |
|
216
|
1 |
|
$templates = $templates[$id]; |
|
217
|
|
|
} |
|
218
|
|
|
} |
|
219
|
|
|
|
|
220
|
5 |
|
return $templates; |
|
221
|
|
|
} |
|
222
|
|
|
} |
|
223
|
|
|
|
Respect /
Validation
Loading history...
Let?s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let?s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: