vendor/symfony/serializer/Normalizer/AbstractObjectNormalizer.php line 184

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\Serializer\Normalizer;
  14. use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException;
  15. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  16. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  17. use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
  18. use Symfony\Component\PropertyInfo\Type;
  19. use Symfony\Component\Serializer\Encoder\CsvEncoder;
  20. use Symfony\Component\Serializer\Encoder\JsonEncoder;
  21. use Symfony\Component\Serializer\Encoder\XmlEncoder;
  22. use Symfony\Component\Serializer\Exception\ExtraAttributesException;
  23. use Symfony\Component\Serializer\Exception\LogicException;
  24. use Symfony\Component\Serializer\Exception\MissingConstructorArgumentsException;
  25. use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
  26. use Symfony\Component\Serializer\Mapping\AttributeMetadataInterface;
  27. use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
  28. use Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface;
  29. use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
  30. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  32. /**
  33.  * Base class for a normalizer dealing with objects.
  34.  *
  35.  * @author Kévin Dunglas <dunglas@gmail.com>
  36.  */
  37. abstract class AbstractObjectNormalizer extends AbstractNormalizer
  38. {
  39.     /**
  40.      * Set to true to respect the max depth metadata on fields.
  41.      */
  42.     public const ENABLE_MAX_DEPTH = 'enable_max_depth';
  44.     /**
  45.      * How to track the current depth in the context.
  46.      */
  47.     public const DEPTH_KEY_PATTERN = 'depth_%s::%s';
  49.     /**
  50.      * While denormalizing, we can verify that types match.
  51.      *
  52.      * You can disable this by setting this flag to true.
  53.      */
  54.     public const DISABLE_TYPE_ENFORCEMENT = 'disable_type_enforcement';
  56.     /**
  57.      * Flag to control whether fields with the value `null` should be output
  58.      * when normalizing or omitted.
  59.      */
  60.     public const SKIP_NULL_VALUES = 'skip_null_values';
  62.     /**
  63.      * Flag to control whether uninitialized PHP>=7.4 typed class properties
  64.      * should be excluded when normalizing.
  65.      */
  66.     public const SKIP_UNINITIALIZED_VALUES = 'skip_uninitialized_values';
  68.     /**
  69.      * Callback to allow to set a value for an attribute when the max depth has
  70.      * been reached.
  71.      *
  72.      * If no callback is given, the attribute is skipped. If a callable is
  73.      * given, its return value is used (even if null).
  74.      *
  75.      * The arguments are:
  76.      *
  77.      * - mixed  $attributeValue value of this field
  78.      * - object $object         the whole object being normalized
  79.      * - string $attributeName  name of the attribute being normalized
  80.      * - string $format         the requested format
  81.      * - array  $context        the serialization context
  82.      */
  83.     public const MAX_DEPTH_HANDLER = 'max_depth_handler';
  85.     /**
  86.      * Specify which context key are not relevant to determine which attributes
  87.      * of an object to (de)normalize.
  88.      */
  89.     public const EXCLUDE_FROM_CACHE_KEY = 'exclude_from_cache_key';
  91.     /**
  92.      * Flag to tell the denormalizer to also populate existing objects on
  93.      * attributes of the main object.
  94.      *
  95.      * Setting this to true is only useful if you also specify the root object
  96.      * in OBJECT_TO_POPULATE.
  97.      */
  98.     public const DEEP_OBJECT_TO_POPULATE = 'deep_object_to_populate';
  100.     /**
  101.      * Flag to control whether an empty object should be kept as an object (in
  102.      * JSON: {}) or converted to a list (in JSON: []).
  103.      */
  104.     public const PRESERVE_EMPTY_OBJECTS = 'preserve_empty_objects';
  106.     private $propertyTypeExtractor;
  107.     private $typesCache = [];
  108.     private $attributesCache = [];
  110.     private $objectClassResolver;
  112.     /**
  113.      * @var ClassDiscriminatorResolverInterface|null
  114.      */
  115.     protected $classDiscriminatorResolver;
  117.     public function __construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null, ClassDiscriminatorResolverInterface $classDiscriminatorResolver = null, callable $objectClassResolver = null, array $defaultContext = [])
  118.     {
  119.         parent::__construct($classMetadataFactory, $nameConverter, $defaultContext);
  121.         if (isset($this->defaultContext[self::MAX_DEPTH_HANDLER]) && !\is_callable($this->defaultContext[self::MAX_DEPTH_HANDLER])) {
  122.             throw new InvalidArgumentException(sprintf('The "%s" given in the default context is not callable.', self::MAX_DEPTH_HANDLER));
  123.         }
  125.         $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] = array_merge($this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] ?? [], [self::CIRCULAR_REFERENCE_LIMIT_COUNTERS]);
  127.         $this->propertyTypeExtractor = $propertyTypeExtractor;
  129.         if (null === $classDiscriminatorResolver && null !== $classMetadataFactory) {
  130.             $classDiscriminatorResolver = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
  131.         }
  132.         $this->classDiscriminatorResolver = $classDiscriminatorResolver;
  133.         $this->objectClassResolver = $objectClassResolver;
  134.     }
  136.     /**
  137.      * {@inheritdoc}
  138.      *
  139.      * @param array $context
  140.      */
  141.     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */)
  142.     {
  143.         return \is_object($data) && !$data instanceof \Traversable;
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function normalize(mixed $object, string $format = null, array $context = [])
  150.     {
  151.         if (!isset($context['cache_key'])) {
  152.             $context['cache_key'] = $this->getCacheKey($format, $context);
  153.         }
  155.         $this->validateCallbackContext($context);
  157.         if ($this->isCircularReference($object, $context)) {
  158.             return $this->handleCircularReference($object, $format, $context);
  159.         }
  161.         $data = [];
  162.         $stack = [];
  163.         $attributes = $this->getAttributes($object, $format, $context);
  164.         $class = $this->objectClassResolver ? ($this->objectClassResolver)($object) : \get_class($object);
  165.         $attributesMetadata = $this->classMetadataFactory?->getMetadataFor($class)->getAttributesMetadata();
  166.         if (isset($context[self::MAX_DEPTH_HANDLER])) {
  167.             $maxDepthHandler = $context[self::MAX_DEPTH_HANDLER];
  168.             if (!\is_callable($maxDepthHandler)) {
  169.                 throw new InvalidArgumentException(sprintf('The "%s" given in the context is not callable.', self::MAX_DEPTH_HANDLER));
  170.             }
  171.         } else {
  172.             $maxDepthHandler = null;
  173.         }
  175.         foreach ($attributes as $attribute) {
  176.             $maxDepthReached = false;
  177.             if (null !== $attributesMetadata && ($maxDepthReached = $this->isMaxDepthReached($attributesMetadata, $class, $attribute, $context)) && !$maxDepthHandler) {
  178.                 continue;
  179.             }
  181.             $attributeContext = $this->getAttributeNormalizationContext($object, $attribute, $context);
  183.             try {
  184.                 $attributeValue = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
  185.             } catch (UninitializedPropertyException $e) {
  186.                 if ($context[self::SKIP_UNINITIALIZED_VALUES] ?? $this->defaultContext[self::SKIP_UNINITIALIZED_VALUES] ?? true) {
  187.                     continue;
  188.                 }
  189.                 throw $e;
  190.             } catch (\Error $e) {
  191.                 if (($context[self::SKIP_UNINITIALIZED_VALUES] ?? $this->defaultContext[self::SKIP_UNINITIALIZED_VALUES] ?? true) && $this->isUninitializedValueError($e)) {
  192.                     continue;
  193.                 }
  194.                 throw $e;
  195.             }
  197.             if ($maxDepthReached) {
  198.                 $attributeValue = $maxDepthHandler($attributeValue, $object, $attribute, $format, $attributeContext);
  199.             }
  201.             $attributeValue = $this->applyCallbacks($attributeValue, $object, $attribute, $format, $attributeContext);
  203.             if (null !== $attributeValue && !\is_scalar($attributeValue)) {
  204.                 $stack[$attribute] = $attributeValue;
  205.             }
  207.             $data = $this->updateData($data, $attribute, $attributeValue, $class, $format, $attributeContext);
  208.         }
  210.         foreach ($stack as $attribute => $attributeValue) {
  211.             if (!$this->serializer instanceof NormalizerInterface) {
  212.                 throw new LogicException(sprintf('Cannot normalize attribute "%s" because the injected serializer is not a normalizer.', $attribute));
  213.             }
  215.             $attributeContext = $this->getAttributeNormalizationContext($object, $attribute, $context);
  216.             $childContext = $this->createChildContext($attributeContext, $attribute, $format);
  218.             $data = $this->updateData($data, $attribute, $this->serializer->normalize($attributeValue, $format, $childContext), $class, $format, $attributeContext);
  219.         }
  221.         $preserveEmptyObjects = $context[self::PRESERVE_EMPTY_OBJECTS] ?? $this->defaultContext[self::PRESERVE_EMPTY_OBJECTS] ?? false;
  222.         if ($preserveEmptyObjects && !\count($data)) {
  223.             return new \ArrayObject();
  224.         }
  226.         return $data;
  227.     }
  229.     /**
  230.      * Computes the normalization context merged with current one. Metadata always wins over global context, as more specific.
  231.      */
  232.     private function getAttributeNormalizationContext(object $object, string $attribute, array $context): array
  233.     {
  234.         if (null === $metadata = $this->getAttributeMetadata($object, $attribute)) {
  235.             return $context;
  236.         }
  238.         return array_merge($context, $metadata->getNormalizationContextForGroups($this->getGroups($context)));
  239.     }
  241.     /**
  242.      * Computes the denormalization context merged with current one. Metadata always wins over global context, as more specific.
  243.      */
  244.     private function getAttributeDenormalizationContext(string $class, string $attribute, array $context): array
  245.     {
  246.         $context['deserialization_path'] = ($context['deserialization_path'] ?? false) ? $context['deserialization_path'].'.'.$attribute : $attribute;
  248.         if (null === $metadata = $this->getAttributeMetadata($class, $attribute)) {
  249.             return $context;
  250.         }
  252.         return array_merge($context, $metadata->getDenormalizationContextForGroups($this->getGroups($context)));
  253.     }
  255.     private function getAttributeMetadata(object|string $objectOrClass, string $attribute): ?AttributeMetadataInterface
  256.     {
  257.         if (!$this->classMetadataFactory) {
  258.             return null;
  259.         }
  261.         return $this->classMetadataFactory->getMetadataFor($objectOrClass)->getAttributesMetadata()[$attribute] ?? null;
  262.     }
  264.     /**
  265.      * {@inheritdoc}
  266.      */
  267.     protected function instantiateObject(array &$data, string $class, array &$context, \ReflectionClass $reflectionClass, array|bool $allowedAttributes, string $format = null)
  268.     {
  269.         if ($this->classDiscriminatorResolver && $mapping = $this->classDiscriminatorResolver->getMappingForClass($class)) {
  270.             if (!isset($data[$mapping->getTypeProperty()])) {
  271.                 throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Type property "%s" not found for the abstract object "%s".', $mapping->getTypeProperty(), $class), null, ['string'], isset($context['deserialization_path']) ? $context['deserialization_path'].'.'.$mapping->getTypeProperty() : $mapping->getTypeProperty(), false);
  272.             }
  274.             $type = $data[$mapping->getTypeProperty()];
  275.             if (null === ($mappedClass = $mapping->getClassForType($type))) {
  276.                 throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The type "%s" is not a valid value.', $type), $type, ['string'], isset($context['deserialization_path']) ? $context['deserialization_path'].'.'.$mapping->getTypeProperty() : $mapping->getTypeProperty(), true);
  277.             }
  279.             if ($mappedClass !== $class) {
  280.                 return $this->instantiateObject($data, $mappedClass, $context, new \ReflectionClass($mappedClass), $allowedAttributes, $format);
  281.             }
  282.         }
  284.         return parent::instantiateObject($data, $class, $context, $reflectionClass, $allowedAttributes, $format);
  285.     }
  287.     /**
  288.      * Gets and caches attributes for the given object, format and context.
  289.      *
  290.      * @return string[]
  291.      */
  292.     protected function getAttributes(object $object, ?string $format, array $context): array
  293.     {
  294.         $class = $this->objectClassResolver ? ($this->objectClassResolver)($object) : \get_class($object);
  295.         $key = $class.'-'.$context['cache_key'];
  297.         if (isset($this->attributesCache[$key])) {
  298.             return $this->attributesCache[$key];
  299.         }
  301.         $allowedAttributes = $this->getAllowedAttributes($object, $context, true);
  303.         if (false !== $allowedAttributes) {
  304.             if ($context['cache_key']) {
  305.                 $this->attributesCache[$key] = $allowedAttributes;
  306.             }
  308.             return $allowedAttributes;
  309.         }
  311.         $attributes = $this->extractAttributes($object, $format, $context);
  313.         if ($this->classDiscriminatorResolver && $mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object)) {
  314.             array_unshift($attributes, $mapping->getTypeProperty());
  315.         }
  317.         if ($context['cache_key'] && \stdClass::class !== $class) {
  318.             $this->attributesCache[$key] = $attributes;
  319.         }
  321.         return $attributes;
  322.     }
  324.     /**
  325.      * Extracts attributes to normalize from the class of the given object, format and context.
  326.      *
  327.      * @return string[]
  328.      */
  329.     abstract protected function extractAttributes(object $object, string $format = null, array $context = []);
  331.     /**
  332.      * Gets the attribute value.
  333.      *
  334.      * @return mixed
  335.      */
  336.     abstract protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = []);
  338.     /**
  339.      * {@inheritdoc}
  340.      *
  341.      * @param array $context
  342.      */
  343.     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */)
  344.     {
  345.         return class_exists($type) || (interface_exists($type, false) && $this->classDiscriminatorResolver && null !== $this->classDiscriminatorResolver->getMappingForClass($type));
  346.     }
  348.     /**
  349.      * {@inheritdoc}
  350.      */
  351.     public function denormalize(mixed $data, string $type, string $format = null, array $context = [])
  352.     {
  353.         if (!isset($context['cache_key'])) {
  354.             $context['cache_key'] = $this->getCacheKey($format, $context);
  355.         }
  357.         $this->validateCallbackContext($context);
  359.         if (null === $data && isset($context['value_type']) && $context['value_type'] instanceof Type && $context['value_type']->isNullable()) {
  360.             return null;
  361.         }
  363.         $allowedAttributes = $this->getAllowedAttributes($type, $context, true);
  364.         $normalizedData = $this->prepareForDenormalization($data);
  365.         $extraAttributes = [];
  367.         $reflectionClass = new \ReflectionClass($type);
  368.         $object = $this->instantiateObject($normalizedData, $type, $context, $reflectionClass, $allowedAttributes, $format);
  369.         $resolvedClass = $this->objectClassResolver ? ($this->objectClassResolver)($object) : \get_class($object);
  371.         foreach ($normalizedData as $attribute => $value) {
  372.             if ($this->nameConverter) {
  373.                 $attribute = $this->nameConverter->denormalize($attribute, $resolvedClass, $format, $context);
  374.             }
  376.             $attributeContext = $this->getAttributeDenormalizationContext($resolvedClass, $attribute, $context);
  378.             if ((false !== $allowedAttributes && !\in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($resolvedClass, $attribute, $format, $context)) {
  379.                 if (!($context[self::ALLOW_EXTRA_ATTRIBUTES] ?? $this->defaultContext[self::ALLOW_EXTRA_ATTRIBUTES])) {
  380.                     $extraAttributes[] = $attribute;
  381.                 }
  383.                 continue;
  384.             }
  386.             if ($attributeContext[self::DEEP_OBJECT_TO_POPULATE] ?? $this->defaultContext[self::DEEP_OBJECT_TO_POPULATE] ?? false) {
  387.                 try {
  388.                     $attributeContext[self::OBJECT_TO_POPULATE] = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
  389.                 } catch (NoSuchPropertyException) {
  390.                 }
  391.             }
  393.             $types = $this->getTypes($resolvedClass, $attribute);
  395.             if (null !== $types) {
  396.                 try {
  397.                     $value = $this->validateAndDenormalize($types, $resolvedClass, $attribute, $value, $format, $attributeContext);
  398.                 } catch (NotNormalizableValueException $exception) {
  399.                     if (isset($context['not_normalizable_value_exceptions'])) {
  400.                         $context['not_normalizable_value_exceptions'][] = $exception;
  401.                         continue;
  402.                     }
  403.                     throw $exception;
  404.                 }
  405.             }
  407.             $value = $this->applyCallbacks($value, $resolvedClass, $attribute, $format, $attributeContext);
  409.             try {
  410.                 $this->setAttributeValue($object, $attribute, $value, $format, $attributeContext);
  411.             } catch (InvalidArgumentException $e) {
  412.                 $exception = NotNormalizableValueException::createForUnexpectedDataType(
  413.                     sprintf('Failed to denormalize attribute "%s" value for class "%s": '.$e->getMessage(), $attribute, $type),
  414.                     $data,
  415.                     ['unknown'],
  416.                     $context['deserialization_path'] ?? null,
  417.                     false,
  418.                     $e->getCode(),
  419.                     $e
  420.                 );
  421.                 if (isset($context['not_normalizable_value_exceptions'])) {
  422.                     $context['not_normalizable_value_exceptions'][] = $exception;
  423.                     continue;
  424.                 }
  425.                 throw $exception;
  426.             }
  427.         }
  429.         if ($extraAttributes) {
  430.             throw new ExtraAttributesException($extraAttributes);
  431.         }
  433.         return $object;
  434.     }
  436.     /**
  437.      * Sets attribute value.
  438.      */
  439.     abstract protected function setAttributeValue(object $object, string $attribute, mixed $value, string $format = null, array $context = []);
  441.     /**
  442.      * Validates the submitted data and denormalizes it.
  443.      *
  444.      * @param Type[] $types
  445.      *
  446.      * @throws NotNormalizableValueException
  447.      * @throws ExtraAttributesException
  448.      * @throws MissingConstructorArgumentsException
  449.      * @throws LogicException
  450.      */
  451.     private function validateAndDenormalize(array $types, string $currentClass, string $attribute, mixed $data, ?string $format, array $context): mixed
  452.     {
  453.         $expectedTypes = [];
  454.         $isUnionType = \count($types) > 1;
  455.         $extraAttributesException = null;
  456.         $missingConstructorArgumentException = null;
  457.         foreach ($types as $type) {
  458.             if (null === $data && $type->isNullable()) {
  459.                 return null;
  460.             }
  462.             $collectionValueType = $type->isCollection() ? $type->getCollectionValueTypes()[0] ?? null : null;
  464.             // Fix a collection that contains the only one element
  465.             // This is special to xml format only
  466.             if ('xml' === $format && null !== $collectionValueType && (!\is_array($data) || !\is_int(key($data)))) {
  467.                 $data = [$data];
  468.             }
  470.             // This try-catch should cover all NotNormalizableValueException (and all return branches after the first
  471.             // exception) so we could try denormalizing all types of an union type. If the target type is not an union
  472.             // type, we will just re-throw the catched exception.
  473.             // In the case of no denormalization succeeds with an union type, it will fall back to the default exception
  474.             // with the acceptable types list.
  475.             try {
  476.                 // In XML and CSV all basic datatypes are represented as strings, it is e.g. not possible to determine,
  477.                 // if a value is meant to be a string, float, int or a boolean value from the serialized representation.
  478.                 // That's why we have to transform the values, if one of these non-string basic datatypes is expected.
  479.                 if (\is_string($data) && (XmlEncoder::FORMAT === $format || CsvEncoder::FORMAT === $format)) {
  480.                     if ('' === $data) {
  481.                         if (Type::BUILTIN_TYPE_ARRAY === $builtinType = $type->getBuiltinType()) {
  482.                             return [];
  483.                         }
  485.                         if ($type->isNullable() && \in_array($builtinType, [Type::BUILTIN_TYPE_BOOL, Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_FLOAT], true)) {
  486.                             return null;
  487.                         }
  488.                     }
  490.                     switch ($builtinType ?? $type->getBuiltinType()) {
  491.                         case Type::BUILTIN_TYPE_BOOL:
  492.                             // according to https://www.w3.org/TR/xmlschema-2/#boolean, valid representations are "false", "true", "0" and "1"
  493.                             if ('false' === $data || '0' === $data) {
  494.                                 $data = false;
  495.                             } elseif ('true' === $data || '1' === $data) {
  496.                                 $data = true;
  497.                             } else {
  498.                                 throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The type of the "%s" attribute for class "%s" must be bool ("%s" given).', $attribute, $currentClass, $data), $data, [Type::BUILTIN_TYPE_BOOL], $context['deserialization_path'] ?? null);
  499.                             }
  500.                             break;
  501.                         case Type::BUILTIN_TYPE_INT:
  502.                             if (ctype_digit($data) || '-' === $data[0] && ctype_digit(substr($data, 1))) {
  503.                                 $data = (int) $data;
  504.                             } else {
  505.                                 throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The type of the "%s" attribute for class "%s" must be int ("%s" given).', $attribute, $currentClass, $data), $data, [Type::BUILTIN_TYPE_INT], $context['deserialization_path'] ?? null);
  506.                             }
  507.                             break;
  508.                         case Type::BUILTIN_TYPE_FLOAT:
  509.                             if (is_numeric($data)) {
  510.                                 return (float) $data;
  511.                             }
  513.                             return match ($data) {
  514.                                 'NaN' => \NAN,
  515.                                 'INF' => \INF,
  516.                                 '-INF' => -\INF,
  517.                                 default => throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The type of the "%s" attribute for class "%s" must be float ("%s" given).', $attribute, $currentClass, $data), $data, [Type::BUILTIN_TYPE_FLOAT], $context['deserialization_path'] ?? null),
  518.                             };
  519.                     }
  520.                 }
  522.                 if (null !== $collectionValueType && Type::BUILTIN_TYPE_OBJECT === $collectionValueType->getBuiltinType()) {
  523.                     $builtinType = Type::BUILTIN_TYPE_OBJECT;
  524.                     $class = $collectionValueType->getClassName().'[]';
  526.                     if (\count($collectionKeyType = $type->getCollectionKeyTypes()) > 0) {
  527.                         [$context['key_type']] = $collectionKeyType;
  528.                     }
  530.                     $context['value_type'] = $collectionValueType;
  531.                 } elseif ($type->isCollection() && \count($collectionValueType = $type->getCollectionValueTypes()) > 0 && Type::BUILTIN_TYPE_ARRAY === $collectionValueType[0]->getBuiltinType()) {
  532.                     // get inner type for any nested array
  533.                     [$innerType] = $collectionValueType;
  535.                     // note that it will break for any other builtinType
  536.                     $dimensions = '[]';
  537.                     while (\count($innerType->getCollectionValueTypes()) > 0 && Type::BUILTIN_TYPE_ARRAY === $innerType->getBuiltinType()) {
  538.                         $dimensions .= '[]';
  539.                         [$innerType] = $innerType->getCollectionValueTypes();
  540.                     }
  542.                     if (null !== $innerType->getClassName()) {
  543.                         // the builtinType is the inner one and the class is the class followed by []...[]
  544.                         $builtinType = $innerType->getBuiltinType();
  545.                         $class = $innerType->getClassName().$dimensions;
  546.                     } else {
  547.                         // default fallback (keep it as array)
  548.                         $builtinType = $type->getBuiltinType();
  549.                         $class = $type->getClassName();
  550.                     }
  551.                 } else {
  552.                     $builtinType = $type->getBuiltinType();
  553.                     $class = $type->getClassName();
  554.                 }
  556.                 $expectedTypes[Type::BUILTIN_TYPE_OBJECT === $builtinType && $class ? $class : $builtinType] = true;
  558.                 if (Type::BUILTIN_TYPE_OBJECT === $builtinType) {
  559.                     if (!$this->serializer instanceof DenormalizerInterface) {
  560.                         throw new LogicException(sprintf('Cannot denormalize attribute "%s" for class "%s" because injected serializer is not a denormalizer.', $attribute, $class));
  561.                     }
  563.                     $childContext = $this->createChildContext($context, $attribute, $format);
  564.                     if ($this->serializer->supportsDenormalization($data, $class, $format, $childContext)) {
  565.                         return $this->serializer->denormalize($data, $class, $format, $childContext);
  566.                     }
  567.                 }
  569.                 // JSON only has a Number type corresponding to both int and float PHP types.
  570.                 // PHP's json_encode, JavaScript's JSON.stringify, Go's json.Marshal as well as most other JSON encoders convert
  571.                 // floating-point numbers like 12.0 to 12 (the decimal part is dropped when possible).
  572.                 // PHP's json_decode automatically converts Numbers without a decimal part to integers.
  573.                 // To circumvent this behavior, integers are converted to floats when denormalizing JSON based formats and when
  574.                 // a float is expected.
  575.                 if (Type::BUILTIN_TYPE_FLOAT === $builtinType && \is_int($data) && null !== $format && str_contains($format, JsonEncoder::FORMAT)) {
  576.                     return (float) $data;
  577.                 }
  579.                 if (Type::BUILTIN_TYPE_FALSE === $builtinType && false === $data) {
  580.                     return $data;
  581.                 }
  583.                 if (('is_'.$builtinType)($data)) {
  584.                     return $data;
  585.                 }
  586.             } catch (NotNormalizableValueException $e) {
  587.                 if (!$isUnionType) {
  588.                     throw $e;
  589.                 }
  590.             } catch (ExtraAttributesException $e) {
  591.                 if (!$isUnionType) {
  592.                     throw $e;
  593.                 }
  595.                 $extraAttributesException ??= $e;
  596.             } catch (MissingConstructorArgumentsException $e) {
  597.                 if (!$isUnionType) {
  598.                     throw $e;
  599.                 }
  601.                 $missingConstructorArgumentException ??= $e;
  602.             }
  603.         }
  605.         if ($extraAttributesException) {
  606.             throw $extraAttributesException;
  607.         }
  609.         if ($missingConstructorArgumentException) {
  610.             throw $missingConstructorArgumentException;
  611.         }
  613.         if ($context[self::DISABLE_TYPE_ENFORCEMENT] ?? $this->defaultContext[self::DISABLE_TYPE_ENFORCEMENT] ?? false) {
  614.             return $data;
  615.         }
  617.         throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('The type of the "%s" attribute for class "%s" must be one of "%s" ("%s" given).', $attribute, $currentClass, implode('", "', array_keys($expectedTypes)), get_debug_type($data)), $data, array_keys($expectedTypes), $context['deserialization_path'] ?? $attribute);
  618.     }
  620.     /**
  621.      * @internal
  622.      */
  623.     protected function denormalizeParameter(\ReflectionClass $class, \ReflectionParameter $parameter, string $parameterName, mixed $parameterData, array $context, string $format = null): mixed
  624.     {
  625.         if ($parameter->isVariadic() || null === $this->propertyTypeExtractor || null === $types = $this->getTypes($class->getName(), $parameterName)) {
  626.             return parent::denormalizeParameter($class, $parameter, $parameterName, $parameterData, $context, $format);
  627.         }
  629.         $parameterData = $this->validateAndDenormalize($types, $class->getName(), $parameterName, $parameterData, $format, $context);
  631.         return $this->applyCallbacks($parameterData, $class->getName(), $parameterName, $format, $context);
  632.     }
  634.     /**
  635.      * @return Type[]|null
  636.      */
  637.     private function getTypes(string $currentClass, string $attribute): ?array
  638.     {
  639.         if (null === $this->propertyTypeExtractor) {
  640.             return null;
  641.         }
  643.         $key = $currentClass.'::'.$attribute;
  644.         if (isset($this->typesCache[$key])) {
  645.             return false === $this->typesCache[$key] ? null : $this->typesCache[$key];
  646.         }
  648.         if (null !== $types = $this->propertyTypeExtractor->getTypes($currentClass, $attribute)) {
  649.             return $this->typesCache[$key] = $types;
  650.         }
  652.         if (null !== $this->classDiscriminatorResolver && null !== $discriminatorMapping = $this->classDiscriminatorResolver->getMappingForClass($currentClass)) {
  653.             if ($discriminatorMapping->getTypeProperty() === $attribute) {
  654.                 return $this->typesCache[$key] = [
  655.                     new Type(Type::BUILTIN_TYPE_STRING),
  656.                 ];
  657.             }
  659.             foreach ($discriminatorMapping->getTypesMapping() as $mappedClass) {
  660.                 if (null !== $types = $this->propertyTypeExtractor->getTypes($mappedClass, $attribute)) {
  661.                     return $this->typesCache[$key] = $types;
  662.                 }
  663.             }
  664.         }
  666.         $this->typesCache[$key] = false;
  668.         return null;
  669.     }
  671.     /**
  672.      * Sets an attribute and apply the name converter if necessary.
  673.      */
  674.     private function updateData(array $data, string $attribute, mixed $attributeValue, string $class, ?string $format, array $context): array
  675.     {
  676.         if (null === $attributeValue && ($context[self::SKIP_NULL_VALUES] ?? $this->defaultContext[self::SKIP_NULL_VALUES] ?? false)) {
  677.             return $data;
  678.         }
  680.         if ($this->nameConverter) {
  681.             $attribute = $this->nameConverter->normalize($attribute, $class, $format, $context);
  682.         }
  684.         $data[$attribute] = $attributeValue;
  686.         return $data;
  687.     }
  689.     /**
  690.      * Is the max depth reached for the given attribute?
  691.      *
  692.      * @param AttributeMetadataInterface[] $attributesMetadata
  693.      */
  694.     private function isMaxDepthReached(array $attributesMetadata, string $class, string $attribute, array &$context): bool
  695.     {
  696.         $enableMaxDepth = $context[self::ENABLE_MAX_DEPTH] ?? $this->defaultContext[self::ENABLE_MAX_DEPTH] ?? false;
  697.         if (
  698.             !$enableMaxDepth ||
  699.             !isset($attributesMetadata[$attribute]) ||
  700.             null === $maxDepth = $attributesMetadata[$attribute]->getMaxDepth()
  701.         ) {
  702.             return false;
  703.         }
  705.         $key = sprintf(self::DEPTH_KEY_PATTERN, $class, $attribute);
  706.         if (!isset($context[$key])) {
  707.             $context[$key] = 1;
  709.             return false;
  710.         }
  712.         if ($context[$key] === $maxDepth) {
  713.             return true;
  714.         }
  716.         ++$context[$key];
  718.         return false;
  719.     }
  721.     /**
  722.      * Overwritten to update the cache key for the child.
  723.      *
  724.      * We must not mix up the attribute cache between parent and children.
  725.      *
  726.      * {@inheritdoc}
  727.      *
  728.      * @internal
  729.      */
  730.     protected function createChildContext(array $parentContext, string $attribute, ?string $format): array
  731.     {
  732.         $context = parent::createChildContext($parentContext, $attribute, $format);
  733.         $context['cache_key'] = $this->getCacheKey($format, $context);
  735.         return $context;
  736.     }
  738.     /**
  739.      * Builds the cache key for the attributes cache.
  740.      *
  741.      * The key must be different for every option in the context that could change which attributes should be handled.
  742.      */
  743.     private function getCacheKey(?string $format, array $context): bool|string
  744.     {
  745.         foreach ($context[self::EXCLUDE_FROM_CACHE_KEY] ?? $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] as $key) {
  746.             unset($context[$key]);
  747.         }
  748.         unset($context[self::EXCLUDE_FROM_CACHE_KEY]);
  749.         unset($context[self::OBJECT_TO_POPULATE]);
  750.         unset($context['cache_key']); // avoid artificially different keys
  752.         try {
  753.             return md5($format.serialize([
  754.                 'context' => $context,
  755.                 'ignored' => $context[self::IGNORED_ATTRIBUTES] ?? $this->defaultContext[self::IGNORED_ATTRIBUTES],
  756.             ]));
  757.         } catch (\Exception) {
  758.             // The context cannot be serialized, skip the cache
  759.             return false;
  760.         }
  761.     }
  763.     /**
  764.      * This error may occur when specific object normalizer implementation gets attribute value
  765.      * by accessing a public uninitialized property or by calling a method accessing such property.
  766.      */
  767.     private function isUninitializedValueError(\Error $e): bool
  768.     {
  769.         return str_starts_with($e->getMessage(), 'Typed property')
  770.             && str_ends_with($e->getMessage(), 'must not be accessed before initialization');
  771.     }
  772. }