vendor/symfony/validator/Constraints/Collection.php line 23

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Validator\Constraints;
  14. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  16. /**
  17.  * @Annotation
  18.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  19.  *
  20.  * @author Bernhard Schussek <bschussek@gmail.com>
  21.  */
  22. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  23. class Collection extends Composite
  24. {
  25.     public const MISSING_FIELD_ERROR = '2fa2158c-2a7f-484b-98aa-975522539ff8';
  26.     public const NO_SUCH_FIELD_ERROR = '7703c766-b5d5-4cef-ace7-ae0dd82304e9';
  28.     protected const ERROR_NAMES = [
  29.         self::MISSING_FIELD_ERROR => 'MISSING_FIELD_ERROR',
  30.         self::NO_SUCH_FIELD_ERROR => 'NO_SUCH_FIELD_ERROR',
  31.     ];
  33.     /**
  34.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  35.      */
  36.     protected static $errorNames = self::ERROR_NAMES;
  38.     public $fields = [];
  39.     public $allowExtraFields = false;
  40.     public $allowMissingFields = false;
  41.     public $extraFieldsMessage = 'This field was not expected.';
  42.     public $missingFieldsMessage = 'This field is missing.';
  44.     public function __construct(mixed $fields = null, array $groups = null, mixed $payload = null, bool $allowExtraFields = null, bool $allowMissingFields = null, string $extraFieldsMessage = null, string $missingFieldsMessage = null)
  45.     {
  46.         // no known options set? $fields is the fields array
  47.         if (\is_array($fields)
  48.             && !array_intersect(array_keys($fields), ['groups', 'fields', 'allowExtraFields', 'allowMissingFields', 'extraFieldsMessage', 'missingFieldsMessage'])) {
  49.             $fields = ['fields' => $fields];
  50.         }
  52.         parent::__construct($fields, $groups, $payload);
  54.         $this->allowExtraFields = $allowExtraFields ?? $this->allowExtraFields;
  55.         $this->allowMissingFields = $allowMissingFields ?? $this->allowMissingFields;
  56.         $this->extraFieldsMessage = $extraFieldsMessage ?? $this->extraFieldsMessage;
  57.         $this->missingFieldsMessage = $missingFieldsMessage ?? $this->missingFieldsMessage;
  58.     }
  60.     protected function initializeNestedConstraints()
  61.     {
  62.         parent::initializeNestedConstraints();
  64.         if (!\is_array($this->fields)) {
  65.             throw new ConstraintDefinitionException(sprintf('The option "fields" is expected to be an array in constraint "%s".', __CLASS__));
  66.         }
  68.         foreach ($this->fields as $fieldName => $field) {
  69.             // the XmlFileLoader and YamlFileLoader pass the field Optional
  70.             // and Required constraint as an array with exactly one element
  71.             if (\is_array($field) && 1 == \count($field)) {
  72.                 $this->fields[$fieldName] = $field = $field[0];
  73.             }
  75.             if (!$field instanceof Optional && !$field instanceof Required) {
  76.                 $this->fields[$fieldName] = new Required($field);
  77.             }
  78.         }
  79.     }
  81.     public function getRequiredOptions(): array
  82.     {
  83.         return ['fields'];
  84.     }
  86.     protected function getCompositeOption(): string
  87.     {
  88.         return 'fields';
  89.     }
  90. }