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

Open in your IDE?
  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\Constraint;
  15. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  17. /**
  18.  * @Annotation
  19.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  24. class Collection extends Composite
  25. {
  26.     public const MISSING_FIELD_ERROR = '2fa2158c-2a7f-484b-98aa-975522539ff8';
  27.     public const NO_SUCH_FIELD_ERROR = '7703c766-b5d5-4cef-ace7-ae0dd82304e9';
  29.     protected static $errorNames = [
  30.         self::MISSING_FIELD_ERROR => 'MISSING_FIELD_ERROR',
  31.         self::NO_SUCH_FIELD_ERROR => 'NO_SUCH_FIELD_ERROR',
  32.     ];
  34.     public $fields = [];
  35.     public $allowExtraFields = false;
  36.     public $allowMissingFields = false;
  37.     public $extraFieldsMessage = 'This field was not expected.';
  38.     public $missingFieldsMessage = 'This field is missing.';
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function __construct($fields = null, ?array $groups = null, $payload = null, ?bool $allowExtraFields = null, ?bool $allowMissingFields = null, ?string $extraFieldsMessage = null, ?string $missingFieldsMessage = null)
  44.     {
  45.         if (self::isFieldsOption($fields)) {
  46.             $fields = ['fields' => $fields];
  47.         }
  49.         parent::__construct($fields, $groups, $payload);
  51.         $this->allowExtraFields = $allowExtraFields ?? $this->allowExtraFields;
  52.         $this->allowMissingFields = $allowMissingFields ?? $this->allowMissingFields;
  53.         $this->extraFieldsMessage = $extraFieldsMessage ?? $this->extraFieldsMessage;
  54.         $this->missingFieldsMessage = $missingFieldsMessage ?? $this->missingFieldsMessage;
  55.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      */
  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()
  82.     {
  83.         return ['fields'];
  84.     }
  86.     protected function getCompositeOption()
  87.     {
  88.         return 'fields';
  89.     }
  91.     private static function isFieldsOption($options): bool
  92.     {
  93.         if (!\is_array($options)) {
  94.             return false;
  95.         }
  97.         foreach ($options as $optionOrField) {
  98.             if ($optionOrField instanceof Constraint) {
  99.                 return true;
  100.             }
  102.             if (null === $optionOrField) {
  103.                 continue;
  104.             }
  106.             if (!\is_array($optionOrField)) {
  107.                 return false;
  108.             }
  110.             if ($optionOrField && !($optionOrField[0] ?? null) instanceof Constraint) {
  111.                 return false;
  112.             }
  113.         }
  115.         return true;
  116.     }
  117. }