annotate vendor/symfony/validator/Constraints/CollectionValidator.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator\Constraints;
Chris@0 13
Chris@0 14 use Symfony\Component\Validator\Constraint;
Chris@0 15 use Symfony\Component\Validator\ConstraintValidator;
Chris@0 16 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
Chris@0 17
Chris@0 18 /**
Chris@0 19 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 20 */
Chris@0 21 class CollectionValidator extends ConstraintValidator
Chris@0 22 {
Chris@0 23 /**
Chris@0 24 * {@inheritdoc}
Chris@0 25 */
Chris@0 26 public function validate($value, Constraint $constraint)
Chris@0 27 {
Chris@0 28 if (!$constraint instanceof Collection) {
Chris@0 29 throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Collection');
Chris@0 30 }
Chris@0 31
Chris@0 32 if (null === $value) {
Chris@0 33 return;
Chris@0 34 }
Chris@0 35
Chris@17 36 if (!\is_array($value) && !($value instanceof \Traversable && $value instanceof \ArrayAccess)) {
Chris@0 37 throw new UnexpectedTypeException($value, 'array or Traversable and ArrayAccess');
Chris@0 38 }
Chris@0 39
Chris@0 40 // We need to keep the initialized context when CollectionValidator
Chris@0 41 // calls itself recursively (Collection constraints can be nested).
Chris@0 42 // Since the context of the validator is overwritten when initialize()
Chris@0 43 // is called for the nested constraint, the outer validator is
Chris@0 44 // acting on the wrong context when the nested validation terminates.
Chris@0 45 //
Chris@0 46 // A better solution - which should be approached in Symfony 3.0 - is to
Chris@0 47 // remove the initialize() method and pass the context as last argument
Chris@0 48 // to validate() instead.
Chris@0 49 $context = $this->context;
Chris@0 50
Chris@0 51 foreach ($constraint->fields as $field => $fieldConstraint) {
Chris@0 52 // bug fix issue #2779
Chris@18 53 $existsInArray = \is_array($value) && \array_key_exists($field, $value);
Chris@0 54 $existsInArrayAccess = $value instanceof \ArrayAccess && $value->offsetExists($field);
Chris@0 55
Chris@0 56 if ($existsInArray || $existsInArrayAccess) {
Chris@17 57 if (\count($fieldConstraint->constraints) > 0) {
Chris@0 58 $context->getValidator()
Chris@0 59 ->inContext($context)
Chris@0 60 ->atPath('['.$field.']')
Chris@0 61 ->validate($value[$field], $fieldConstraint->constraints);
Chris@0 62 }
Chris@0 63 } elseif (!$fieldConstraint instanceof Optional && !$constraint->allowMissingFields) {
Chris@0 64 $context->buildViolation($constraint->missingFieldsMessage)
Chris@0 65 ->atPath('['.$field.']')
Chris@0 66 ->setParameter('{{ field }}', $this->formatValue($field))
Chris@0 67 ->setInvalidValue(null)
Chris@0 68 ->setCode(Collection::MISSING_FIELD_ERROR)
Chris@0 69 ->addViolation();
Chris@0 70 }
Chris@0 71 }
Chris@0 72
Chris@0 73 if (!$constraint->allowExtraFields) {
Chris@0 74 foreach ($value as $field => $fieldValue) {
Chris@0 75 if (!isset($constraint->fields[$field])) {
Chris@0 76 $context->buildViolation($constraint->extraFieldsMessage)
Chris@0 77 ->atPath('['.$field.']')
Chris@0 78 ->setParameter('{{ field }}', $this->formatValue($field))
Chris@0 79 ->setInvalidValue($fieldValue)
Chris@0 80 ->setCode(Collection::NO_SUCH_FIELD_ERROR)
Chris@0 81 ->addViolation();
Chris@0 82 }
Chris@0 83 }
Chris@0 84 }
Chris@0 85 }
Chris@0 86 }