vendor/symfony/validator/Constraints/Composite.php line 52

  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.  * A constraint that is composed of other constraints.
  19.  *
  20.  * You should never use the nested constraint instances anywhere else, because
  21.  * their groups are adapted when passed to the constructor of this class.
  22.  *
  23.  * If you want to create your own composite constraint, extend this class and
  24.  * let {@link getCompositeOption()} return the name of the property which
  25.  * contains the nested constraints.
  26.  *
  27.  * @author Bernhard Schussek <bschussek@gmail.com>
  28.  */
  29. abstract class Composite extends Constraint
  30. {
  31.     /**
  32.      * The groups of the composite and its nested constraints are made
  33.      * consistent using the following strategy:
  34.      *
  35.      *   - If groups are passed explicitly to the composite constraint, but
  36.      *     not to the nested constraints, the options of the composite
  37.      *     constraint are copied to the nested constraints;
  38.      *
  39.      *   - If groups are passed explicitly to the nested constraints, but not
  40.      *     to the composite constraint, the groups of all nested constraints
  41.      *     are merged and used as groups for the composite constraint;
  42.      *
  43.      *   - If groups are passed explicitly to both the composite and its nested
  44.      *     constraints, the groups of the nested constraints must be a subset
  45.      *     of the groups of the composite constraint. If not, a
  46.      *     {@link ConstraintDefinitionException} is thrown.
  47.      *
  48.      * All this is done in the constructor, because constraints can then be
  49.      * cached. When constraints are loaded from the cache, no more group
  50.      * checks need to be done.
  51.      */
  52.     public function __construct(mixed $options = null, array $groups = null, mixed $payload = null)
  53.     {
  54.         parent::__construct($options, $groups, $payload);
  56.         $this->initializeNestedConstraints();
  58.         /* @var Constraint[] $nestedConstraints */
  59.         $compositeOption = $this->getCompositeOption();
  60.         $nestedConstraints = $this->$compositeOption;
  62.         if (!\is_array($nestedConstraints)) {
  63.             $nestedConstraints = [$nestedConstraints];
  64.         }
  66.         foreach ($nestedConstraints as $constraint) {
  67.             if (!$constraint instanceof Constraint) {
  68.                 if (\is_object($constraint)) {
  69.                     $constraint = $constraint::class;
  70.                 }
  72.                 throw new ConstraintDefinitionException(sprintf('The value "%s" is not an instance of Constraint in constraint "%s".', $constraint, static::class));
  73.             }
  75.             if ($constraint instanceof Valid) {
  76.                 throw new ConstraintDefinitionException(sprintf('The constraint Valid cannot be nested inside constraint "%s". You can only declare the Valid constraint directly on a field or method.', static::class));
  77.             }
  78.         }
  80.         if (!isset(((array) $this)['groups'])) {
  81.             $mergedGroups = [];
  83.             foreach ($nestedConstraints as $constraint) {
  84.                 foreach ($constraint->groups as $group) {
  85.                     $mergedGroups[$group] = true;
  86.                 }
  87.             }
  89.             // prevent empty composite constraint to have empty groups
  90.             $this->groups = array_keys($mergedGroups) ?: [self::DEFAULT_GROUP];
  91.             $this->$compositeOption = $nestedConstraints;
  93.             return;
  94.         }
  96.         foreach ($nestedConstraints as $constraint) {
  97.             if (isset(((array) $constraint)['groups'])) {
  98.                 $excessGroups = array_diff($constraint->groups, $this->groups);
  100.                 if (\count($excessGroups) > 0) {
  101.                     throw new ConstraintDefinitionException(sprintf('The group(s) "%s" passed to the constraint "%s" should also be passed to its containing constraint "%s".', implode('", "', $excessGroups), get_debug_type($constraint), static::class));
  102.                 }
  103.             } else {
  104.                 $constraint->groups = $this->groups;
  105.             }
  106.         }
  108.         $this->$compositeOption = $nestedConstraints;
  109.     }
  111.     /**
  112.      * Implicit group names are forwarded to nested constraints.
  113.      */
  114.     public function addImplicitGroupName(string $group)
  115.     {
  116.         parent::addImplicitGroupName($group);
  118.         /** @var Constraint[] $nestedConstraints */
  119.         $nestedConstraints = $this->{$this->getCompositeOption()};
  121.         foreach ($nestedConstraints as $constraint) {
  122.             $constraint->addImplicitGroupName($group);
  123.         }
  124.     }
  126.     /**
  127.      * Returns the name of the property that contains the nested constraints.
  128.      */
  129.     abstract protected function getCompositeOption(): string;
  131.     /**
  132.      * @internal Used by metadata
  133.      *
  134.      * @return Constraint[]
  135.      */
  136.     public function getNestedConstraints(): array
  137.     {
  138.         /* @var Constraint[] $nestedConstraints */
  139.         return $this->{$this->getCompositeOption()};
  140.     }
  142.     /**
  143.      * Initializes the nested constraints.
  144.      *
  145.      * This method can be overwritten in subclasses to clean up the nested
  146.      * constraints passed to the constructor.
  147.      *
  148.      * @see Collection::initializeNestedConstraints()
  149.      */
  150.     protected function initializeNestedConstraints()
  151.     {
  152.     }
  153. }