mirror of
https://github.com/symfony/validator.git
synced 2026-03-24 01:12:13 +01:00
cc6e683b9d
* 7.4: [HttpClient] Fix caching client decorating scoping client [DownCralwer] Fix inline type info [FrameworkBundle] Add missing `container.excluded` to `serializer.attribute_metadata` [DomCrawler] Fix converting HTML5 trees to DOM nodes [VarDumper] Fix dumping CurlHttpClient instances [DomCrawler] Properly ignore errors when using the native HTML5 parser [Validator] Correct PHPDoc for Collection constructor
83 lines
3.4 KiB
PHP
83 lines
3.4 KiB
PHP
<?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\Constraint;
|
|
use Symfony\Component\Validator\Exception\MissingOptionsException;
|
|
|
|
/**
|
|
* 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|list<Constraint>>|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)
|
|
*/
|
|
public function __construct(?array $fields = null, ?array $groups = null, mixed $payload = null, ?bool $allowExtraFields = null, ?bool $allowMissingFields = null, ?string $extraFieldsMessage = null, ?string $missingFieldsMessage = null)
|
|
{
|
|
if (null === $fields) {
|
|
throw new MissingOptionsException(\sprintf('The options "fields" must be set for constraint "%s".', self::class), ['fields']);
|
|
}
|
|
|
|
$this->fields = $fields;
|
|
|
|
parent::__construct(null, $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 ?? []);
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function getCompositeOption(): string
|
|
{
|
|
return 'fields';
|
|
}
|
|
}
|