-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
GenericMetadata.php
237 lines (206 loc) · 6.26 KB
/
GenericMetadata.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
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Validator\Mapping;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Traverse;
use Symfony\Component\Validator\Constraints\Valid;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
/**
* A generic container of {@link Constraint} objects.
*
* This class supports serialization and cloning.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class GenericMetadata implements MetadataInterface
{
/**
* @var Constraint[]
*
* @internal This property is public in order to reduce the size of the
* class' serialized representation. Do not access it. Use
* {@link getConstraints()} and {@link findConstraints()} instead.
*/
public $constraints = [];
/**
* @var array
*
* @internal This property is public in order to reduce the size of the
* class' serialized representation. Do not access it. Use
* {@link findConstraints()} instead.
*/
public $constraintsByGroup = [];
/**
* The strategy for cascading objects.
*
* By default, objects are not cascaded.
*
* @var int
*
* @see CascadingStrategy
*
* @internal This property is public in order to reduce the size of the
* class' serialized representation. Do not access it. Use
* {@link getCascadingStrategy()} instead.
*/
public $cascadingStrategy = CascadingStrategy::NONE;
/**
* The strategy for traversing traversable objects.
*
* By default, traversable objects are not traversed.
*
* @var int
*
* @see TraversalStrategy
*
* @internal This property is public in order to reduce the size of the
* class' serialized representation. Do not access it. Use
* {@link getTraversalStrategy()} instead.
*/
public $traversalStrategy = TraversalStrategy::NONE;
/**
* Returns the names of the properties that should be serialized.
*
* @return string[]
*/
public function __sleep()
{
return [
'constraints',
'constraintsByGroup',
'cascadingStrategy',
'traversalStrategy',
];
}
/**
* Clones this object.
*/
public function __clone()
{
$constraints = $this->constraints;
$this->constraints = [];
$this->constraintsByGroup = [];
foreach ($constraints as $constraint) {
$this->addConstraint(clone $constraint);
}
}
/**
* Adds a constraint.
*
* If the constraint {@link Valid} is added, the cascading strategy will be
* changed to {@link CascadingStrategy::CASCADE}. Depending on the
* $traverse property of that constraint, the traversal strategy
* will be set to one of the following:
*
* - {@link TraversalStrategy::IMPLICIT} if $traverse is enabled
* - {@link TraversalStrategy::NONE} if $traverse is disabled
*
* @return $this
*
* @throws ConstraintDefinitionException When trying to add the
* {@link Traverse} constraint
*/
public function addConstraint(Constraint $constraint)
{
if ($constraint instanceof Traverse) {
throw new ConstraintDefinitionException(sprintf('The constraint "%s" can only be put on classes. Please use "Symfony\Component\Validator\Constraints\Valid" instead.', \get_class($constraint)));
}
if ($constraint instanceof Valid && null === $constraint->groups) {
$this->cascadingStrategy = CascadingStrategy::CASCADE;
if ($constraint->traverse) {
$this->traversalStrategy = TraversalStrategy::IMPLICIT;
} else {
$this->traversalStrategy = TraversalStrategy::NONE;
}
return $this;
}
$this->constraints[] = $constraint;
foreach ($constraint->groups as $group) {
$this->constraintsByGroup[$group][] = $constraint;
}
return $this;
}
/**
* Adds an list of constraints.
*
* @param Constraint[] $constraints The constraints to add
*
* @return $this
*/
public function addConstraints(array $constraints)
{
foreach ($constraints as $constraint) {
$this->addConstraint($constraint);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getConstraints()
{
$this->configureLengthConstraints($this->constraints);
return $this->constraints;
}
/**
* Returns whether this element has any constraints.
*
* @return bool
*/
public function hasConstraints()
{
return \count($this->constraints) > 0;
}
/**
* {@inheritdoc}
*
* Aware of the global group (* group).
*/
public function findConstraints($group)
{
$constraints = $this->constraintsByGroup[$group] ?? [];
$this->configureLengthConstraints($constraints);
return $constraints;
}
/**
* {@inheritdoc}
*/
public function getCascadingStrategy()
{
return $this->cascadingStrategy;
}
/**
* {@inheritdoc}
*/
public function getTraversalStrategy()
{
return $this->traversalStrategy;
}
private function configureLengthConstraints(array $constraints): void
{
$allowEmptyString = true;
foreach ($constraints as $constraint) {
if ($constraint instanceof NotBlank) {
$allowEmptyString = false;
break;
}
}
if ($allowEmptyString) {
return;
}
foreach ($constraints as $constraint) {
if ($constraint instanceof Length && null === $constraint->allowEmptyString) {
$constraint->allowEmptyString = false;
}
}
}
}