-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
Collection.php
115 lines (95 loc) · 4.19 KB
/
Collection.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
<?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\Constraints;
use Symfony\Component\Validator\Attribute\HasNamedArguments;
use Symfony\Component\Validator\Constraint;
/**
* Validates a collection with constraints defined for specific keys.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
class Collection extends Composite
{
public const MISSING_FIELD_ERROR = '2fa2158c-2a7f-484b-98aa-975522539ff8';
public const NO_SUCH_FIELD_ERROR = '7703c766-b5d5-4cef-ace7-ae0dd82304e9';
protected const ERROR_NAMES = [
self::MISSING_FIELD_ERROR => 'MISSING_FIELD_ERROR',
self::NO_SUCH_FIELD_ERROR => 'NO_SUCH_FIELD_ERROR',
];
public array $fields = [];
public bool $allowExtraFields = false;
public bool $allowMissingFields = false;
public string $extraFieldsMessage = 'This field was not expected.';
public string $missingFieldsMessage = 'This field is missing.';
/**
* @param array<string,Constraint>|array<string,mixed>|null $fields An associative array defining keys in the collection and their constraints
* @param string[]|null $groups
* @param bool|null $allowExtraFields Whether to allow additional keys not declared in the configured fields (defaults to false)
* @param bool|null $allowMissingFields Whether to allow the collection to lack some fields declared in the configured fields (defaults to false)
*/
#[HasNamedArguments]
public function __construct(mixed $fields = null, ?array $groups = null, mixed $payload = null, ?bool $allowExtraFields = null, ?bool $allowMissingFields = null, ?string $extraFieldsMessage = null, ?string $missingFieldsMessage = null)
{
if (self::isFieldsOption($fields)) {
$fields = ['fields' => $fields];
} else {
trigger_deprecation('symfony/validator', '7.2', 'Passing an array of options to configure the %s constraint is deprecated, use named arguments instead.', static::class);
}
parent::__construct($fields, $groups, $payload);
$this->allowExtraFields = $allowExtraFields ?? $this->allowExtraFields;
$this->allowMissingFields = $allowMissingFields ?? $this->allowMissingFields;
$this->extraFieldsMessage = $extraFieldsMessage ?? $this->extraFieldsMessage;
$this->missingFieldsMessage = $missingFieldsMessage ?? $this->missingFieldsMessage;
}
protected function initializeNestedConstraints(): void
{
parent::initializeNestedConstraints();
foreach ($this->fields as $fieldName => $field) {
// the XmlFileLoader and YamlFileLoader pass the field Optional
// and Required constraint as an array with exactly one element
if (\is_array($field) && 1 == \count($field)) {
$this->fields[$fieldName] = $field = $field[0];
}
if (!$field instanceof Optional && !$field instanceof Required) {
$this->fields[$fieldName] = new Required($field);
}
}
}
public function getRequiredOptions(): array
{
return ['fields'];
}
protected function getCompositeOption(): string
{
return 'fields';
}
private static function isFieldsOption($options): bool
{
if (!\is_array($options)) {
return false;
}
foreach ($options as $optionOrField) {
if ($optionOrField instanceof Constraint) {
return true;
}
if (null === $optionOrField) {
continue;
}
if (!\is_array($optionOrField)) {
return false;
}
if ($optionOrField && !($optionOrField[0] ?? null) instanceof Constraint) {
return false;
}
}
return true;
}
}