123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240 |
- <?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\Mapping;
- use Symfony\Component\Validator\Constraint;
- use Symfony\Component\Validator\Constraints\Cascade;
- use Symfony\Component\Validator\Constraints\DisableAutoMapping;
- use Symfony\Component\Validator\Constraints\EnableAutoMapping;
- use Symfony\Component\Validator\Constraints\Traverse;
- use Symfony\Component\Validator\Constraints\Valid;
- use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
- /**
- * A generic container of {@link Constraint} objects.
- *
- * This class supports serialization and cloning.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class GenericMetadata implements MetadataInterface
- {
- /**
- * @var Constraint[]
- *
- * @internal This property is public in order to reduce the size of the
- * class' serialized representation. Do not access it. Use
- * {@link getConstraints()} and {@link findConstraints()} instead.
- */
- public $constraints = [];
- /**
- * @var array
- *
- * @internal This property is public in order to reduce the size of the
- * class' serialized representation. Do not access it. Use
- * {@link findConstraints()} instead.
- */
- public $constraintsByGroup = [];
- /**
- * The strategy for cascading objects.
- *
- * By default, objects are not cascaded.
- *
- * @var int
- *
- * @see CascadingStrategy
- *
- * @internal This property is public in order to reduce the size of the
- * class' serialized representation. Do not access it. Use
- * {@link getCascadingStrategy()} instead.
- */
- public $cascadingStrategy = CascadingStrategy::NONE;
- /**
- * The strategy for traversing traversable objects.
- *
- * By default, traversable objects are not traversed.
- *
- * @var int
- *
- * @see TraversalStrategy
- *
- * @internal This property is public in order to reduce the size of the
- * class' serialized representation. Do not access it. Use
- * {@link getTraversalStrategy()} instead.
- */
- public $traversalStrategy = TraversalStrategy::NONE;
- /**
- * Is auto-mapping enabled?
- *
- * @var int
- *
- * @see AutoMappingStrategy
- *
- * @internal This property is public in order to reduce the size of the
- * class' serialized representation. Do not access it. Use
- * {@link getAutoMappingStrategy()} instead.
- */
- public $autoMappingStrategy = AutoMappingStrategy::NONE;
- /**
- * Returns the names of the properties that should be serialized.
- *
- * @return string[]
- */
- public function __sleep()
- {
- return [
- 'constraints',
- 'constraintsByGroup',
- 'cascadingStrategy',
- 'traversalStrategy',
- 'autoMappingStrategy',
- ];
- }
- /**
- * Clones this object.
- */
- public function __clone()
- {
- $constraints = $this->constraints;
- $this->constraints = [];
- $this->constraintsByGroup = [];
- foreach ($constraints as $constraint) {
- $this->addConstraint(clone $constraint);
- }
- }
- /**
- * Adds a constraint.
- *
- * If the constraint {@link Valid} is added, the cascading strategy will be
- * changed to {@link CascadingStrategy::CASCADE}. Depending on the
- * $traverse property of that constraint, the traversal strategy
- * will be set to one of the following:
- *
- * - {@link TraversalStrategy::IMPLICIT} if $traverse is enabled
- * - {@link TraversalStrategy::NONE} if $traverse is disabled
- *
- * @return $this
- *
- * @throws ConstraintDefinitionException When trying to add the {@link Cascade}
- * or {@link Traverse} constraint
- */
- public function addConstraint(Constraint $constraint)
- {
- if ($constraint instanceof Traverse || $constraint instanceof Cascade) {
- throw new ConstraintDefinitionException(sprintf('The constraint "%s" can only be put on classes. Please use "Symfony\Component\Validator\Constraints\Valid" instead.', get_debug_type($constraint)));
- }
- if ($constraint instanceof Valid && null === $constraint->groups) {
- $this->cascadingStrategy = CascadingStrategy::CASCADE;
- if ($constraint->traverse) {
- $this->traversalStrategy = TraversalStrategy::IMPLICIT;
- } else {
- $this->traversalStrategy = TraversalStrategy::NONE;
- }
- return $this;
- }
- if ($constraint instanceof DisableAutoMapping || $constraint instanceof EnableAutoMapping) {
- $this->autoMappingStrategy = $constraint instanceof EnableAutoMapping ? AutoMappingStrategy::ENABLED : AutoMappingStrategy::DISABLED;
- // The constraint is not added
- return $this;
- }
- $this->constraints[] = $constraint;
- foreach ($constraint->groups as $group) {
- $this->constraintsByGroup[$group][] = $constraint;
- }
- return $this;
- }
- /**
- * Adds an list of constraints.
- *
- * @param Constraint[] $constraints The constraints to add
- *
- * @return $this
- */
- public function addConstraints(array $constraints)
- {
- foreach ($constraints as $constraint) {
- $this->addConstraint($constraint);
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getConstraints()
- {
- return $this->constraints;
- }
- /**
- * Returns whether this element has any constraints.
- *
- * @return bool
- */
- public function hasConstraints()
- {
- return \count($this->constraints) > 0;
- }
- /**
- * {@inheritdoc}
- *
- * Aware of the global group (* group).
- */
- public function findConstraints(string $group)
- {
- return $this->constraintsByGroup[$group] ?? [];
- }
- /**
- * {@inheritdoc}
- */
- public function getCascadingStrategy()
- {
- return $this->cascadingStrategy;
- }
- /**
- * {@inheritdoc}
- */
- public function getTraversalStrategy()
- {
- return $this->traversalStrategy;
- }
- /**
- * @see AutoMappingStrategy
- */
- public function getAutoMappingStrategy(): int
- {
- return $this->autoMappingStrategy;
- }
- }
|