vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php line 132

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the API Platform project.
  4.  *
  5.  * (c) Kévin Dunglas <dunglas@gmail.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. declare(strict_types=1);
  11. namespace ApiPlatform\Serializer;
  12. use ApiPlatform\Api\IriConverterInterface;
  13. use ApiPlatform\Api\UrlGeneratorInterface;
  14. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  15. use ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer as MessengerDataTransformer;
  16. use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
  17. use ApiPlatform\Core\DataTransformer\DataTransformerInitializerInterface;
  18. use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
  19. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface as LegacyPropertyMetadataFactoryInterface;
  20. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  21. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  22. use ApiPlatform\Exception\InvalidArgumentException;
  23. use ApiPlatform\Exception\InvalidValueException;
  24. use ApiPlatform\Exception\ItemNotFoundException;
  25. use ApiPlatform\Metadata\ApiProperty;
  26. use ApiPlatform\Metadata\CollectionOperationInterface;
  27. use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  28. use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  29. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  30. use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
  31. use ApiPlatform\Util\ClassInfoTrait;
  32. use ApiPlatform\Util\CloneTrait;
  33. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  34. use Symfony\Component\PropertyAccess\PropertyAccess;
  35. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  36. use Symfony\Component\PropertyInfo\Type;
  37. use Symfony\Component\Serializer\Encoder\CsvEncoder;
  38. use Symfony\Component\Serializer\Encoder\XmlEncoder;
  39. use Symfony\Component\Serializer\Exception\LogicException;
  40. use Symfony\Component\Serializer\Exception\MissingConstructorArgumentsException;
  41. use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
  42. use Symfony\Component\Serializer\Exception\RuntimeException;
  43. use Symfony\Component\Serializer\Exception\UnexpectedValueException;
  44. use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
  45. use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
  46. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  47. use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
  48. use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
  49. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  50. /**
  51.  * Base item normalizer.
  52.  *
  53.  * @author Kévin Dunglas <dunglas@gmail.com>
  54.  */
  55. abstract class AbstractItemNormalizer extends AbstractObjectNormalizer
  56. {
  57.     use ClassInfoTrait;
  58.     use CloneTrait;
  59.     use ContextTrait;
  60.     use InputOutputMetadataTrait;
  61.     public const IS_TRANSFORMED_TO_SAME_CLASS 'is_transformed_to_same_class';
  62.     /**
  63.      * @var PropertyNameCollectionFactoryInterface
  64.      */
  65.     protected $propertyNameCollectionFactory;
  66.     /**
  67.      * @var LegacyPropertyMetadataFactoryInterface|PropertyMetadataFactoryInterface
  68.      */
  69.     protected $propertyMetadataFactory;
  70.     protected $resourceMetadataFactory;
  71.     /**
  72.      * @var LegacyIriConverterInterface|IriConverterInterface
  73.      */
  74.     protected $iriConverter;
  75.     protected $resourceClassResolver;
  76.     protected $resourceAccessChecker;
  77.     protected $propertyAccessor;
  78.     protected $itemDataProvider;
  79.     protected $allowPlainIdentifiers;
  80.     protected $dataTransformers = [];
  81.     protected $localCache = [];
  82.     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory$propertyMetadataFactory$iriConverter$resourceClassResolverPropertyAccessorInterface $propertyAccessor nullNameConverterInterface $nameConverter nullClassMetadataFactoryInterface $classMetadataFactory nullItemDataProviderInterface $itemDataProvider nullbool $allowPlainIdentifiers false, array $defaultContext = [], iterable $dataTransformers = [], $resourceMetadataFactory nullResourceAccessCheckerInterface $resourceAccessChecker null)
  83.     {
  84.         if (!isset($defaultContext['circular_reference_handler'])) {
  85.             $defaultContext['circular_reference_handler'] = function ($object) {
  86.                 return $this->iriConverter instanceof LegacyIriConverterInterface $this->iriConverter->getIriFromItem($object) : $this->iriConverter->getIriFromResource($object);
  87.             };
  88.         }
  89.         if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($this'setCircularReferenceHandler')) {
  90.             $this->setCircularReferenceHandler($defaultContext['circular_reference_handler']);
  91.         }
  92.         parent::__construct($classMetadataFactory$nameConverternullnull, \Closure::fromCallable([$this'getObjectClass']), $defaultContext);
  93.         $this->propertyNameCollectionFactory $propertyNameCollectionFactory;
  94.         $this->propertyMetadataFactory $propertyMetadataFactory;
  95.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  96.             trigger_deprecation('api-platform/core''2.7'sprintf('Use an implementation of "%s" instead of "%s".'IriConverterInterface::class, LegacyIriConverterInterface::class));
  97.         }
  98.         $this->iriConverter $iriConverter;
  99.         $this->resourceClassResolver $resourceClassResolver;
  100.         $this->propertyAccessor $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  101.         $this->itemDataProvider $itemDataProvider;
  102.         if (true === $allowPlainIdentifiers) {
  103.             @trigger_error(sprintf('Allowing plain identifiers as argument of "%s" is deprecated since API Platform 2.7 and will not be possible anymore in API Platform 3.'self::class), \E_USER_DEPRECATED);
  104.         }
  105.         $this->allowPlainIdentifiers $allowPlainIdentifiers;
  106.         $this->dataTransformers $dataTransformers;
  107.         // Just skip our data transformer to trigger a proper deprecation
  108.         $customDataTransformers array_filter(\is_array($dataTransformers) ? $dataTransformers iterator_to_array($dataTransformers), function ($dataTransformer) {
  109.             return !$dataTransformer instanceof MessengerDataTransformer;
  110.         });
  111.         if (\count($customDataTransformers)) {
  112.             trigger_deprecation('api-platform/core''2.7''The DataTransformer pattern is deprecated, use a Provider or a Processor and either use your input or return a new output there.');
  113.         }
  114.         if ($resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  115.             trigger_deprecation('api-platform/core''2.7'sprintf('Use "%s" instead of "%s".'ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  116.         }
  117.         $this->resourceMetadataFactory $resourceMetadataFactory;
  118.         $this->resourceAccessChecker $resourceAccessChecker;
  119.     }
  120.     /**
  121.      * {@inheritdoc}
  122.      */
  123.     public function supportsNormalization($data$format null, array $context = []): bool
  124.     {
  125.         if (!\is_object($data) || is_iterable($data)) {
  126.             return false;
  127.         }
  128.         $class $this->getObjectClass($data);
  129.         if (($context['output']['class'] ?? null) === $class) {
  130.             return true;
  131.         }
  132.         return $this->resourceClassResolver->isResourceClass($class);
  133.     }
  134.     /**
  135.      * {@inheritdoc}
  136.      */
  137.     public function hasCacheableSupportsMethod(): bool
  138.     {
  139.         return true;
  140.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      *
  144.      * @throws LogicException
  145.      *
  146.      * @return array|string|int|float|bool|\ArrayObject|null
  147.      */
  148.     public function normalize($object$format null, array $context = [])
  149.     {
  150.         $resourceClass $this->getObjectClass($object);
  151.         if (!($isTransformed = isset($context[self::IS_TRANSFORMED_TO_SAME_CLASS])) && $outputClass $this->getOutputClass($resourceClass$context)) {
  152.             if (!$this->serializer instanceof NormalizerInterface) {
  153.                 throw new LogicException('Cannot normalize the output because the injected serializer is not a normalizer');
  154.             }
  155.             // Data transformers are deprecated, this is removed from 3.0
  156.             if ($dataTransformer $this->getDataTransformer($object$outputClass$context)) {
  157.                 $transformed $dataTransformer->transform($object$outputClass$context);
  158.                 if ($object === $transformed) {
  159.                     $context[self::IS_TRANSFORMED_TO_SAME_CLASS] = true;
  160.                 } else {
  161.                     $context['api_normalize'] = true;
  162.                     $context['api_resource'] = $object;
  163.                     unset($context['output'], $context['resource_class']);
  164.                 }
  165.                 return $this->serializer->normalize($transformed$format$context);
  166.             }
  167.             unset($context['output'], $context['operation_name']);
  168.             if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface && !isset($context['operation'])) {
  169.                 $context['operation'] = $this->resourceMetadataFactory->create($context['resource_class'])->getOperation();
  170.             }
  171.             $context['resource_class'] = $outputClass;
  172.             $context['api_sub_level'] = true;
  173.             $context[self::ALLOW_EXTRA_ATTRIBUTES] = false;
  174.             return $this->serializer->normalize($object$format$context);
  175.         }
  176.         if ($isTransformed) {
  177.             unset($context[self::IS_TRANSFORMED_TO_SAME_CLASS]);
  178.         }
  179.         if ($isResourceClass $this->resourceClassResolver->isResourceClass($resourceClass)) {
  180.             $context $this->initContext($resourceClass$context);
  181.         }
  182.         if (isset($context['operation']) && $context['operation'] instanceof CollectionOperationInterface) {
  183.             unset($context['operation_name']);
  184.             unset($context['operation']);
  185.             unset($context['iri']);
  186.         }
  187.         $iri null;
  188.         if (isset($context['iri'])) {
  189.             $iri $context['iri'];
  190.         } elseif ($this->iriConverter instanceof LegacyIriConverterInterface && $isResourceClass) {
  191.             $iri $this->iriConverter->getIriFromItem($object);
  192.         } elseif ($this->iriConverter instanceof IriConverterInterface) {
  193.             $iri $this->iriConverter->getIriFromResource($objectUrlGeneratorInterface::ABS_URL$context['operation'] ?? null$context);
  194.         }
  195.         $context['iri'] = $iri;
  196.         $context['api_normalize'] = true;
  197.         /*
  198.          * When true, converts the normalized data array of a resource into an
  199.          * IRI, if the normalized data array is empty.
  200.          *
  201.          * This is useful when traversing from a non-resource towards an attribute
  202.          * which is a resource, as we do not have the benefit of {@see PropertyMetadata::isReadableLink}.
  203.          *
  204.          * It must not be propagated to subresources, as {@see PropertyMetadata::isReadableLink}
  205.          * should take effect.
  206.          */
  207.         $emptyResourceAsIri $context['api_empty_resource_as_iri'] ?? false;
  208.         unset($context['api_empty_resource_as_iri']);
  209.         if (isset($context['resources'])) {
  210.             $context['resources'][$iri] = $iri;
  211.         }
  212.         $data parent::normalize($object$format$context);
  213.         if ($emptyResourceAsIri && \is_array($data) && === \count($data)) {
  214.             return $iri;
  215.         }
  216.         return $data;
  217.     }
  218.     /**
  219.      * {@inheritdoc}
  220.      *
  221.      * @return bool
  222.      */
  223.     public function supportsDenormalization($data$type$format null, array $context = [])
  224.     {
  225.         if (($context['input']['class'] ?? null) === $type) {
  226.             return true;
  227.         }
  228.         return $this->localCache[$type] ?? $this->localCache[$type] = $this->resourceClassResolver->isResourceClass($type);
  229.     }
  230.     /**
  231.      * {@inheritdoc}
  232.      *
  233.      * @return mixed
  234.      */
  235.     public function denormalize($data$class$format null, array $context = [])
  236.     {
  237.         $resourceClass $class;
  238.         if (null !== $inputClass $this->getInputClass($resourceClass$context)) {
  239.             if (null !== $dataTransformer $this->getDataTransformer($data$resourceClass$context)) {
  240.                 $dataTransformerContext $context;
  241.                 unset($context['input']);
  242.                 unset($context['resource_class']);
  243.                 if (!$this->serializer instanceof DenormalizerInterface) {
  244.                     throw new LogicException('Cannot denormalize the input because the injected serializer is not a denormalizer');
  245.                 }
  246.                 if ($dataTransformer instanceof DataTransformerInitializerInterface) {
  247.                     $context[AbstractObjectNormalizer::OBJECT_TO_POPULATE] = $dataTransformer->initialize($inputClass$context);
  248.                     $context[AbstractObjectNormalizer::DEEP_OBJECT_TO_POPULATE] = true;
  249.                 }
  250.                 try {
  251.                     $denormalizedInput $this->serializer->denormalize($data$inputClass$format$context);
  252.                 } catch (NotNormalizableValueException $e) {
  253.                     throw new UnexpectedValueException('The input data is misformatted.'$e->getCode(), $e);
  254.                 }
  255.                 if (!\is_object($denormalizedInput)) {
  256.                     throw new UnexpectedValueException('Expected denormalized input to be an object.');
  257.                 }
  258.                 return $dataTransformer->transform($denormalizedInput$resourceClass$dataTransformerContext);
  259.             }
  260.             unset($context['input']);
  261.             unset($context['operation']);
  262.             unset($context['operation_name']);
  263.             $context['resource_class'] = $inputClass;
  264.             if (!$this->serializer instanceof DenormalizerInterface) {
  265.                 throw new LogicException('Cannot denormalize the input because the injected serializer is not a denormalizer');
  266.             }
  267.             try {
  268.                 return $this->serializer->denormalize($data$inputClass$format$context);
  269.             } catch (NotNormalizableValueException $e) {
  270.                 throw new UnexpectedValueException('The input data is misformatted.'$e->getCode(), $e);
  271.             }
  272.         }
  273.         if (null === $objectToPopulate $this->extractObjectToPopulate($class$context, static::OBJECT_TO_POPULATE)) {
  274.             $normalizedData = \is_scalar($data) ? [$data] : $this->prepareForDenormalization($data);
  275.             $class $this->getClassDiscriminatorResolvedClass($normalizedData$class);
  276.         }
  277.         $context['api_denormalize'] = true;
  278.         if ($this->resourceClassResolver->isResourceClass($class)) {
  279.             $resourceClass $this->resourceClassResolver->getResourceClass($objectToPopulate$class);
  280.             $context['resource_class'] = $resourceClass;
  281.         }
  282.         $supportsPlainIdentifiers $this->supportsPlainIdentifiers();
  283.         if (\is_string($data)) {
  284.             try {
  285.                 return $this->iriConverter instanceof LegacyIriConverterInterface $this->iriConverter->getItemFromIri($data$context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($data$context + ['fetch_data' => true]);
  286.             } catch (ItemNotFoundException $e) {
  287.                 if (!$supportsPlainIdentifiers) {
  288.                     throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
  289.                 }
  290.             } catch (InvalidArgumentException $e) {
  291.                 if (!$supportsPlainIdentifiers) {
  292.                     throw new UnexpectedValueException(sprintf('Invalid IRI "%s".'$data), $e->getCode(), $e);
  293.                 }
  294.             }
  295.         }
  296.         if (!\is_array($data)) {
  297.             if (!$supportsPlainIdentifiers) {
  298.                 throw new UnexpectedValueException(sprintf('Expected IRI or document for resource "%s", "%s" given.'$resourceClass, \gettype($data)));
  299.             }
  300.             $item $this->itemDataProvider->getItem($resourceClass$datanull$context + ['fetch_data' => true]);
  301.             if (null === $item) {
  302.                 throw new ItemNotFoundException(sprintf('Item not found for resource "%s" with id "%s".'$resourceClass$data));
  303.             }
  304.             return $item;
  305.         }
  306.         $previousObject $this->clone($objectToPopulate);
  307.         $object parent::denormalize($data$resourceClass$format$context);
  308.         if (!$this->resourceClassResolver->isResourceClass($context['resource_class'])) {
  309.             return $object;
  310.         }
  311.         // Bypass the post-denormalize attribute revert logic if the object could not be
  312.         // cloned since we cannot possibly revert any changes made to it.
  313.         if (null !== $objectToPopulate && null === $previousObject) {
  314.             return $object;
  315.         }
  316.         // Revert attributes that aren't allowed to be changed after a post-denormalize check
  317.         foreach (array_keys($data) as $attribute) {
  318.             if (!$this->canAccessAttributePostDenormalize($object$previousObject$attribute$context)) {
  319.                 if (null !== $previousObject) {
  320.                     $this->setValue($object$attribute$this->propertyAccessor->getValue($previousObject$attribute));
  321.                 } else {
  322.                     $propertyMetadata $this->propertyMetadataFactory->create($resourceClass$attribute$this->getFactoryOptions($context));
  323.                     $this->setValue($object$attribute$propertyMetadata->getDefault());
  324.                 }
  325.             }
  326.         }
  327.         return $object;
  328.     }
  329.     /**
  330.      * Method copy-pasted from symfony/serializer.
  331.      * Remove it after symfony/serializer version update @see https://github.com/symfony/symfony/pull/28263.
  332.      *
  333.      * {@inheritdoc}
  334.      *
  335.      * @internal
  336.      *
  337.      * @return object
  338.      */
  339.     protected function instantiateObject(array &$data$class, array &$context, \ReflectionClass $reflectionClass$allowedAttributesstring $format null)
  340.     {
  341.         if (null !== $object $this->extractObjectToPopulate($class$context, static::OBJECT_TO_POPULATE)) {
  342.             unset($context[static::OBJECT_TO_POPULATE]);
  343.             return $object;
  344.         }
  345.         $class $this->getClassDiscriminatorResolvedClass($data$class);
  346.         $reflectionClass = new \ReflectionClass($class);
  347.         $constructor $this->getConstructor($data$class$context$reflectionClass$allowedAttributes);
  348.         if ($constructor) {
  349.             $constructorParameters $constructor->getParameters();
  350.             $params = [];
  351.             foreach ($constructorParameters as $constructorParameter) {
  352.                 $paramName $constructorParameter->name;
  353.                 $key $this->nameConverter $this->nameConverter->normalize($paramName$class$format$context) : $paramName;
  354.                 $allowed false === $allowedAttributes || (\is_array($allowedAttributes) && \in_array($paramName$allowedAttributestrue));
  355.                 $ignored = !$this->isAllowedAttribute($class$paramName$format$context);
  356.                 if ($constructorParameter->isVariadic()) {
  357.                     if ($allowed && !$ignored && (isset($data[$key]) || \array_key_exists($key$data))) {
  358.                         if (!\is_array($data[$paramName])) {
  359.                             throw new RuntimeException(sprintf('Cannot create an instance of %s from serialized data because the variadic parameter %s can only accept an array.'$class$constructorParameter->name));
  360.                         }
  361.                         $params array_merge($params$data[$paramName]);
  362.                     }
  363.                 } elseif ($allowed && !$ignored && (isset($data[$key]) || \array_key_exists($key$data))) {
  364.                     $params[] = $this->createConstructorArgument($data[$key], $key$constructorParameter$context$format);
  365.                     // Don't run set for a parameter passed to the constructor
  366.                     unset($data[$key]);
  367.                 } elseif (isset($context[static::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class][$key])) {
  368.                     $params[] = $context[static::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class][$key];
  369.                 } elseif ($constructorParameter->isDefaultValueAvailable()) {
  370.                     $params[] = $constructorParameter->getDefaultValue();
  371.                 } else {
  372.                     throw new MissingConstructorArgumentsException(sprintf('Cannot create an instance of %s from serialized data because its constructor requires parameter "%s" to be present.'$class$constructorParameter->name));
  373.                 }
  374.             }
  375.             if ($constructor->isConstructor()) {
  376.                 return $reflectionClass->newInstanceArgs($params);
  377.             }
  378.             return $constructor->invokeArgs(null$params);
  379.         }
  380.         return new $class();
  381.     }
  382.     protected function getClassDiscriminatorResolvedClass(array &$datastring $class): string
  383.     {
  384.         if (null === $this->classDiscriminatorResolver || (null === $mapping $this->classDiscriminatorResolver->getMappingForClass($class))) {
  385.             return $class;
  386.         }
  387.         if (!isset($data[$mapping->getTypeProperty()])) {
  388.             throw new RuntimeException(sprintf('Type property "%s" not found for the abstract object "%s"'$mapping->getTypeProperty(), $class));
  389.         }
  390.         $type $data[$mapping->getTypeProperty()];
  391.         if (null === ($mappedClass $mapping->getClassForType($type))) {
  392.             throw new RuntimeException(sprintf('The type "%s" has no mapped class for the abstract object "%s"'$type$class));
  393.         }
  394.         return $mappedClass;
  395.     }
  396.     /**
  397.      * {@inheritdoc}
  398.      */
  399.     protected function createConstructorArgument($parameterDatastring $key, \ReflectionParameter $constructorParameter, array &$contextstring $format null)
  400.     {
  401.         return $this->createAttributeValue($constructorParameter->name$parameterData$format$context);
  402.     }
  403.     /**
  404.      * {@inheritdoc}
  405.      *
  406.      * Unused in this context.
  407.      *
  408.      * @return string[]
  409.      */
  410.     protected function extractAttributes($object$format null, array $context = [])
  411.     {
  412.         return [];
  413.     }
  414.     /**
  415.      * {@inheritdoc}
  416.      *
  417.      * @return array|bool
  418.      */
  419.     protected function getAllowedAttributes($classOrObject, array $context$attributesAsString false)
  420.     {
  421.         if (!$this->resourceClassResolver->isResourceClass($context['resource_class'])) {
  422.             return parent::getAllowedAttributes($classOrObject$context$attributesAsString);
  423.         }
  424.         $resourceClass $this->resourceClassResolver->getResourceClass(null$context['resource_class']); // fix for abstract classes and interfaces
  425.         $options $this->getFactoryOptions($context);
  426.         $propertyNames $this->propertyNameCollectionFactory->create($resourceClass$options);
  427.         $allowedAttributes = [];
  428.         foreach ($propertyNames as $propertyName) {
  429.             $propertyMetadata $this->propertyMetadataFactory->create($resourceClass$propertyName$options);
  430.             if (
  431.                 $this->isAllowedAttribute($classOrObject$propertyNamenull$context) &&
  432.                 (
  433.                     isset($context['api_normalize']) && $propertyMetadata->isReadable() ||
  434.                     isset($context['api_denormalize']) && ($propertyMetadata->isWritable() || !\is_object($classOrObject) && $propertyMetadata->isInitializable())
  435.                 )
  436.             ) {
  437.                 $allowedAttributes[] = $propertyName;
  438.             }
  439.         }
  440.         return $allowedAttributes;
  441.     }
  442.     /**
  443.      * {@inheritdoc}
  444.      *
  445.      * @return bool
  446.      */
  447.     protected function isAllowedAttribute($classOrObject$attribute$format null, array $context = [])
  448.     {
  449.         if (!parent::isAllowedAttribute($classOrObject$attribute$format$context)) {
  450.             return false;
  451.         }
  452.         return $this->canAccessAttribute(\is_object($classOrObject) ? $classOrObject null$attribute$context);
  453.     }
  454.     /**
  455.      * Check if access to the attribute is granted.
  456.      *
  457.      * @param object $object
  458.      */
  459.     protected function canAccessAttribute($objectstring $attribute, array $context = []): bool
  460.     {
  461.         if (!$this->resourceClassResolver->isResourceClass($context['resource_class'])) {
  462.             return true;
  463.         }
  464.         $options $this->getFactoryOptions($context);
  465.         /** @var PropertyMetadata|ApiProperty */
  466.         $propertyMetadata $this->propertyMetadataFactory->create($context['resource_class'], $attribute$options);
  467.         $security $propertyMetadata instanceof PropertyMetadata $propertyMetadata->getAttribute('security') : $propertyMetadata->getSecurity();
  468.         if ($this->resourceAccessChecker && $security) {
  469.             return $this->resourceAccessChecker->isGranted($context['resource_class'], $security, [
  470.                 'object' => $object,
  471.             ]);
  472.         }
  473.         return true;
  474.     }
  475.     /**
  476.      * Check if access to the attribute is granted.
  477.      *
  478.      * @param object      $object
  479.      * @param object|null $previousObject
  480.      */
  481.     protected function canAccessAttributePostDenormalize($object$previousObjectstring $attribute, array $context = []): bool
  482.     {
  483.         $options $this->getFactoryOptions($context);
  484.         /** @var PropertyMetadata|ApiProperty */
  485.         $propertyMetadata $this->propertyMetadataFactory->create($context['resource_class'], $attribute$options);
  486.         $security $propertyMetadata instanceof PropertyMetadata $propertyMetadata->getAttribute('security_post_denormalize') : $propertyMetadata->getSecurityPostDenormalize();
  487.         if ($this->resourceAccessChecker && $security) {
  488.             return $this->resourceAccessChecker->isGranted($context['resource_class'], $security, [
  489.                 'object' => $object,
  490.                 'previous_object' => $previousObject,
  491.             ]);
  492.         }
  493.         return true;
  494.     }
  495.     /**
  496.      * {@inheritdoc}
  497.      */
  498.     protected function setAttributeValue($object$attribute$value$format null, array $context = [])
  499.     {
  500.         $this->setValue($object$attribute$this->createAttributeValue($attribute$value$format$context));
  501.     }
  502.     /**
  503.      * Validates the type of the value. Allows using integers as floats for JSON formats.
  504.      *
  505.      * @param mixed $value
  506.      *
  507.      * @throws InvalidArgumentException
  508.      */
  509.     protected function validateType(string $attributeType $type$valuestring $format null)
  510.     {
  511.         $builtinType $type->getBuiltinType();
  512.         if (Type::BUILTIN_TYPE_FLOAT === $builtinType && null !== $format && false !== strpos($format'json')) {
  513.             $isValid = \is_float($value) || \is_int($value);
  514.         } else {
  515.             $isValid = \call_user_func('is_'.$builtinType$value);
  516.         }
  517.         if (!$isValid) {
  518.             throw new UnexpectedValueException(sprintf('The type of the "%s" attribute must be "%s", "%s" given.'$attribute$builtinType, \gettype($value)));
  519.         }
  520.     }
  521.     /**
  522.      * Denormalizes a collection of objects.
  523.      *
  524.      * @param ApiProperty|PropertyMetadata $propertyMetadata
  525.      * @param mixed                        $value
  526.      *
  527.      * @throws InvalidArgumentException
  528.      */
  529.     protected function denormalizeCollection(string $attribute$propertyMetadataType $typestring $className$value, ?string $format, array $context): array
  530.     {
  531.         if (!\is_array($value)) {
  532.             throw new InvalidArgumentException(sprintf('The type of the "%s" attribute must be "array", "%s" given.'$attribute, \gettype($value)));
  533.         }
  534.         $collectionKeyType method_exists(Type::class, 'getCollectionKeyTypes') ? ($type->getCollectionKeyTypes()[0] ?? null) : $type->getCollectionKeyType();
  535.         $collectionKeyBuiltinType null === $collectionKeyType null $collectionKeyType->getBuiltinType();
  536.         $values = [];
  537.         foreach ($value as $index => $obj) {
  538.             if (null !== $collectionKeyBuiltinType && !\call_user_func('is_'.$collectionKeyBuiltinType$index)) {
  539.                 throw new InvalidArgumentException(sprintf('The type of the key "%s" must be "%s", "%s" given.'$index$collectionKeyBuiltinType, \gettype($index)));
  540.             }
  541.             $values[$index] = $this->denormalizeRelation($attribute$propertyMetadata$className$obj$format$this->createChildContext($context$attribute$format));
  542.         }
  543.         return $values;
  544.     }
  545.     /**
  546.      * Denormalizes a relation.
  547.      *
  548.      * @param ApiProperty|PropertyMetadata $propertyMetadata
  549.      * @param mixed                        $value
  550.      *
  551.      * @throws LogicException
  552.      * @throws UnexpectedValueException
  553.      * @throws ItemNotFoundException
  554.      *
  555.      * @return object|null
  556.      */
  557.     protected function denormalizeRelation(string $attributeName$propertyMetadatastring $className$value, ?string $format, array $context)
  558.     {
  559.         $supportsPlainIdentifiers $this->supportsPlainIdentifiers();
  560.         if (\is_string($value)) {
  561.             try {
  562.                 return $this->iriConverter instanceof LegacyIriConverterInterface $this->iriConverter->getItemFromIri($value$context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($value$context + ['fetch_data' => true]);
  563.             } catch (ItemNotFoundException $e) {
  564.                 if (!$supportsPlainIdentifiers) {
  565.                     throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
  566.                 }
  567.             } catch (InvalidArgumentException $e) {
  568.                 if (!$supportsPlainIdentifiers) {
  569.                     throw new UnexpectedValueException(sprintf('Invalid IRI "%s".'$value), $e->getCode(), $e);
  570.                 }
  571.             }
  572.         }
  573.         if ($propertyMetadata->isWritableLink()) {
  574.             $context['api_allow_update'] = true;
  575.             if (!$this->serializer instanceof DenormalizerInterface) {
  576.                 throw new LogicException(sprintf('The injected serializer must be an instance of "%s".'DenormalizerInterface::class));
  577.             }
  578.             try {
  579.                 $item $this->serializer->denormalize($value$className$format$context);
  580.                 if (!\is_object($item) && null !== $item) {
  581.                     throw new \UnexpectedValueException('Expected item to be an object or null.');
  582.                 }
  583.                 return $item;
  584.             } catch (InvalidValueException $e) {
  585.                 if (!$supportsPlainIdentifiers) {
  586.                     throw $e;
  587.                 }
  588.             }
  589.         }
  590.         if (!\is_array($value)) {
  591.             if (!$supportsPlainIdentifiers) {
  592.                 throw new UnexpectedValueException(sprintf('Expected IRI or nested document for attribute "%s", "%s" given.'$attributeName, \gettype($value)));
  593.             }
  594.             $item $this->itemDataProvider->getItem($className$valuenull$context + ['fetch_data' => true]);
  595.             if (null === $item) {
  596.                 throw new ItemNotFoundException(sprintf('Item not found for resource "%s" with id "%s".'$className$value));
  597.             }
  598.             return $item;
  599.         }
  600.         throw new UnexpectedValueException(sprintf('Nested documents for attribute "%s" are not allowed. Use IRIs instead.'$attributeName));
  601.     }
  602.     /**
  603.      * Gets the options for the property name collection / property metadata factories.
  604.      */
  605.     protected function getFactoryOptions(array $context): array
  606.     {
  607.         $options = [];
  608.         if (isset($context[self::GROUPS])) {
  609.             /* @see https://github.com/symfony/symfony/blob/v4.2.6/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php */
  610.             $options['serializer_groups'] = (array) $context[self::GROUPS];
  611.         }
  612.         if (isset($context['resource_class']) && $this->resourceClassResolver->isResourceClass($context['resource_class']) && $this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  613.             $resourceClass $this->resourceClassResolver->getResourceClass(null$context['resource_class']); // fix for abstract classes and interfaces
  614.             // This is a hot spot, we should avoid calling this here but in many cases we can't
  615.             $operation $context['root_operation'] ?? $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($context['root_operation_name'] ?? $context['operation_name'] ?? null);
  616.             $options['normalization_groups'] = $operation->getNormalizationContext()['groups'] ?? null;
  617.             $options['denormalization_groups'] = $operation->getDenormalizationContext()['groups'] ?? null;
  618.         }
  619.         if (isset($context['operation_name'])) {
  620.             $options['operation_name'] = $context['operation_name'];
  621.         }
  622.         if (isset($context['collection_operation_name'])) {
  623.             $options['collection_operation_name'] = $context['collection_operation_name'];
  624.         }
  625.         if (isset($context['item_operation_name'])) {
  626.             $options['item_operation_name'] = $context['item_operation_name'];
  627.         }
  628.         return $options;
  629.     }
  630.     /**
  631.      * Creates the context to use when serializing a relation.
  632.      *
  633.      * @deprecated since version 2.1, to be removed in 3.0.
  634.      */
  635.     protected function createRelationSerializationContext(string $resourceClass, array $context): array
  636.     {
  637.         @trigger_error(sprintf('The method %s() is deprecated since 2.1 and will be removed in 3.0.'__METHOD__), \E_USER_DEPRECATED);
  638.         return $context;
  639.     }
  640.     /**
  641.      * {@inheritdoc}
  642.      *
  643.      * @throws UnexpectedValueException
  644.      * @throws LogicException
  645.      *
  646.      * @return mixed
  647.      */
  648.     protected function getAttributeValue($object$attribute$format null, array $context = [])
  649.     {
  650.         $context['api_attribute'] = $attribute;
  651.         /** @var ApiProperty|PropertyMetadata */
  652.         $propertyMetadata $this->propertyMetadataFactory->create($context['resource_class'], $attribute$this->getFactoryOptions($context));
  653.         try {
  654.             $attributeValue $this->propertyAccessor->getValue($object$attribute);
  655.         } catch (NoSuchPropertyException $e) {
  656.             // BC to be removed in 3.0
  657.             if ($propertyMetadata instanceof PropertyMetadata && !$propertyMetadata->hasChildInherited()) {
  658.                 throw $e;
  659.             }
  660.             if ($propertyMetadata instanceof ApiProperty) {
  661.                 throw $e;
  662.             }
  663.             $attributeValue null;
  664.         }
  665.         if ($context['api_denormalize'] ?? false) {
  666.             return $attributeValue;
  667.         }
  668.         $type $propertyMetadata instanceof PropertyMetadata $propertyMetadata->getType() : ($propertyMetadata->getBuiltinTypes()[0] ?? null);
  669.         if (
  670.             $type &&
  671.             $type->isCollection() &&
  672.             ($collectionValueType method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType()) &&
  673.             ($className $collectionValueType->getClassName()) &&
  674.             $this->resourceClassResolver->isResourceClass($className)
  675.         ) {
  676.             if (!is_iterable($attributeValue)) {
  677.                 throw new UnexpectedValueException('Unexpected non-iterable value for to-many relation.');
  678.             }
  679.             $resourceClass $this->resourceClassResolver->getResourceClass($attributeValue$className);
  680.             $childContext $this->createChildContext($context$attribute$format);
  681.             $childContext['resource_class'] = $resourceClass;
  682.             if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  683.                 $childContext['operation'] = $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  684.             }
  685.             unset($childContext['iri'], $childContext['uri_variables']);
  686.             return $this->normalizeCollectionOfRelations($propertyMetadata$attributeValue$resourceClass$format$childContext);
  687.         }
  688.         if (
  689.             $type &&
  690.             ($className $type->getClassName()) &&
  691.             $this->resourceClassResolver->isResourceClass($className)
  692.         ) {
  693.             if (!\is_object($attributeValue) && null !== $attributeValue) {
  694.                 throw new UnexpectedValueException('Unexpected non-object value for to-one relation.');
  695.             }
  696.             $resourceClass $this->resourceClassResolver->getResourceClass($attributeValue$className);
  697.             $childContext $this->createChildContext($context$attribute$format);
  698.             $childContext['resource_class'] = $resourceClass;
  699.             if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  700.                 $childContext['operation'] = $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  701.             }
  702.             unset($childContext['iri'], $childContext['uri_variables']);
  703.             return $this->normalizeRelation($propertyMetadata$attributeValue$resourceClass$format$childContext);
  704.         }
  705.         if (!$this->serializer instanceof NormalizerInterface) {
  706.             throw new LogicException(sprintf('The injected serializer must be an instance of "%s".'NormalizerInterface::class));
  707.         }
  708.         unset($context['resource_class']);
  709.         if ($type && $type->getClassName()) {
  710.             $childContext $this->createChildContext($context$attribute$format);
  711.             unset($childContext['iri'], $childContext['uri_variables']);
  712.             if ($propertyMetadata instanceof PropertyMetadata) {
  713.                 $childContext['output']['iri'] = $propertyMetadata->getIri() ?? false;
  714.             } else {
  715.                 $childContext['output']['gen_id'] = $propertyMetadata->getGenId() ?? false;
  716.             }
  717.             return $this->serializer->normalize($attributeValue$format$childContext);
  718.         }
  719.         return $this->serializer->normalize($attributeValue$format$context);
  720.     }
  721.     /**
  722.      * Normalizes a collection of relations (to-many).
  723.      *
  724.      * @param ApiProperty|PropertyMetadata $propertyMetadata
  725.      * @param iterable                     $attributeValue
  726.      *
  727.      * @throws UnexpectedValueException
  728.      */
  729.     protected function normalizeCollectionOfRelations($propertyMetadata$attributeValuestring $resourceClass, ?string $format, array $context): array
  730.     {
  731.         $value = [];
  732.         foreach ($attributeValue as $index => $obj) {
  733.             if (!\is_object($obj) && null !== $obj) {
  734.                 throw new UnexpectedValueException('Unexpected non-object element in to-many relation.');
  735.             }
  736.             $value[$index] = $this->normalizeRelation($propertyMetadata$obj$resourceClass$format$context);
  737.         }
  738.         return $value;
  739.     }
  740.     /**
  741.      * Normalizes a relation.
  742.      *
  743.      * @param ApiProperty|PropertyMetadata $propertyMetadata
  744.      * @param object|null                  $relatedObject
  745.      *
  746.      * @throws LogicException
  747.      * @throws UnexpectedValueException
  748.      *
  749.      * @return string|array|\ArrayObject|null IRI or normalized object data
  750.      */
  751.     protected function normalizeRelation($propertyMetadata$relatedObjectstring $resourceClass, ?string $format, array $context)
  752.     {
  753.         if (null === $relatedObject || !empty($context['attributes']) || $propertyMetadata->isReadableLink()) {
  754.             if (!$this->serializer instanceof NormalizerInterface) {
  755.                 throw new LogicException(sprintf('The injected serializer must be an instance of "%s".'NormalizerInterface::class));
  756.             }
  757.             $normalizedRelatedObject $this->serializer->normalize($relatedObject$format$context);
  758.             if (!\is_string($normalizedRelatedObject) && !\is_array($normalizedRelatedObject) && !$normalizedRelatedObject instanceof \ArrayObject && null !== $normalizedRelatedObject) {
  759.                 throw new UnexpectedValueException('Expected normalized relation to be an IRI, array, \ArrayObject or null');
  760.             }
  761.             return $normalizedRelatedObject;
  762.         }
  763.         $iri $this->iriConverter instanceof LegacyIriConverterInterface $this->iriConverter->getIriFromItem($relatedObject) : $this->iriConverter->getIriFromResource($relatedObject);
  764.         if (isset($context['resources'])) {
  765.             $context['resources'][$iri] = $iri;
  766.         }
  767.         $push $propertyMetadata instanceof PropertyMetadata $propertyMetadata->getAttribute('push'false) : ($propertyMetadata->getPush() ?? false);
  768.         if (isset($context['resources_to_push']) && $push) {
  769.             $context['resources_to_push'][$iri] = $iri;
  770.         }
  771.         return $iri;
  772.     }
  773.     /**
  774.      * Finds the first supported data transformer if any.
  775.      *
  776.      * @param object|array $data object on normalize / array on denormalize
  777.      */
  778.     protected function getDataTransformer($datastring $to, array $context = []): ?DataTransformerInterface
  779.     {
  780.         foreach ($this->dataTransformers as $dataTransformer) {
  781.             if ($dataTransformer->supportsTransformation($data$to$context)) {
  782.                 return $dataTransformer;
  783.             }
  784.         }
  785.         return null;
  786.     }
  787.     /**
  788.      * For a given resource, it returns an output representation if any
  789.      * If not, the resource is returned.
  790.      *
  791.      * @param mixed $object
  792.      */
  793.     protected function transformOutput($object, array $context = [], string $outputClass null)
  794.     {
  795.     }
  796.     private function createAttributeValue($attribute$value$format null, array $context = [])
  797.     {
  798.         if (!$this->resourceClassResolver->isResourceClass($context['resource_class'])) {
  799.             return $value;
  800.         }
  801.         /** @var ApiProperty|PropertyMetadata */
  802.         $propertyMetadata $this->propertyMetadataFactory->create($context['resource_class'], $attribute$this->getFactoryOptions($context));
  803.         $type $propertyMetadata instanceof PropertyMetadata $propertyMetadata->getType() : ($propertyMetadata->getBuiltinTypes()[0] ?? null);
  804.         if (null === $type) {
  805.             // No type provided, blindly return the value
  806.             return $value;
  807.         }
  808.         if (null === $value && $type->isNullable()) {
  809.             return $value;
  810.         }
  811.         $collectionValueType method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType();
  812.         /* From @see AbstractObjectNormalizer::validateAndDenormalize() */
  813.         // Fix a collection that contains the only one element
  814.         // This is special to xml format only
  815.         if ('xml' === $format && null !== $collectionValueType && (!\is_array($value) || !\is_int(key($value)))) {
  816.             $value = [$value];
  817.         }
  818.         if (
  819.             $type->isCollection() &&
  820.             null !== $collectionValueType &&
  821.             null !== ($className $collectionValueType->getClassName()) &&
  822.             $this->resourceClassResolver->isResourceClass($className)
  823.         ) {
  824.             $resourceClass $this->resourceClassResolver->getResourceClass(null$className);
  825.             $context['resource_class'] = $resourceClass;
  826.             return $this->denormalizeCollection($attribute$propertyMetadata$type$resourceClass$value$format$context);
  827.         }
  828.         if (
  829.             null !== ($className $type->getClassName()) &&
  830.             $this->resourceClassResolver->isResourceClass($className)
  831.         ) {
  832.             $resourceClass $this->resourceClassResolver->getResourceClass(null$className);
  833.             $childContext $this->createChildContext($context$attribute$format);
  834.             $childContext['resource_class'] = $resourceClass;
  835.             if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  836.                 $childContext['operation'] = $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  837.             }
  838.             return $this->denormalizeRelation($attribute$propertyMetadata$resourceClass$value$format$childContext);
  839.         }
  840.         if (
  841.             $type->isCollection() &&
  842.             null !== $collectionValueType &&
  843.             null !== ($className $collectionValueType->getClassName())
  844.         ) {
  845.             if (!$this->serializer instanceof DenormalizerInterface) {
  846.                 throw new LogicException(sprintf('The injected serializer must be an instance of "%s".'DenormalizerInterface::class));
  847.             }
  848.             unset($context['resource_class']);
  849.             return $this->serializer->denormalize($value$className.'[]'$format$context);
  850.         }
  851.         if (null !== $className $type->getClassName()) {
  852.             if (!$this->serializer instanceof DenormalizerInterface) {
  853.                 throw new LogicException(sprintf('The injected serializer must be an instance of "%s".'DenormalizerInterface::class));
  854.             }
  855.             unset($context['resource_class']);
  856.             return $this->serializer->denormalize($value$className$format$context);
  857.         }
  858.         /* From @see AbstractObjectNormalizer::validateAndDenormalize() */
  859.         // In XML and CSV all basic datatypes are represented as strings, it is e.g. not possible to determine,
  860.         // if a value is meant to be a string, float, int or a boolean value from the serialized representation.
  861.         // That's why we have to transform the values, if one of these non-string basic datatypes is expected.
  862.         if (\is_string($value) && (XmlEncoder::FORMAT === $format || CsvEncoder::FORMAT === $format)) {
  863.             if ('' === $value && $type->isNullable() && \in_array($type->getBuiltinType(), [Type::BUILTIN_TYPE_BOOLType::BUILTIN_TYPE_INTType::BUILTIN_TYPE_FLOAT], true)) {
  864.                 return null;
  865.             }
  866.             switch ($type->getBuiltinType()) {
  867.                 case Type::BUILTIN_TYPE_BOOL:
  868.                     // according to https://www.w3.org/TR/xmlschema-2/#boolean, valid representations are "false", "true", "0" and "1"
  869.                     if ('false' === $value || '0' === $value) {
  870.                         $value false;
  871.                     } elseif ('true' === $value || '1' === $value) {
  872.                         $value true;
  873.                     } else {
  874.                         throw new NotNormalizableValueException(sprintf('The type of the "%s" attribute for class "%s" must be bool ("%s" given).'$attribute$className$value));
  875.                     }
  876.                     break;
  877.                 case Type::BUILTIN_TYPE_INT:
  878.                     if (ctype_digit($value) || ('-' === $value[0] && ctype_digit(substr($value1)))) {
  879.                         $value = (int) $value;
  880.                     } else {
  881.                         throw new NotNormalizableValueException(sprintf('The type of the "%s" attribute for class "%s" must be int ("%s" given).'$attribute$className$value));
  882.                     }
  883.                     break;
  884.                 case Type::BUILTIN_TYPE_FLOAT:
  885.                     if (is_numeric($value)) {
  886.                         return (float) $value;
  887.                     }
  888.                     switch ($value) {
  889.                         case 'NaN':
  890.                             return \NAN;
  891.                         case 'INF':
  892.                             return \INF;
  893.                         case '-INF':
  894.                             return -\INF;
  895.                         default:
  896.                             throw new NotNormalizableValueException(sprintf('The type of the "%s" attribute for class "%s" must be float ("%s" given).'$attribute$className$value));
  897.                     }
  898.             }
  899.         }
  900.         if ($context[static::DISABLE_TYPE_ENFORCEMENT] ?? false) {
  901.             return $value;
  902.         }
  903.         $this->validateType($attribute$type$value$format);
  904.         return $value;
  905.     }
  906.     /**
  907.      * Sets a value of the object using the PropertyAccess component.
  908.      *
  909.      * @param object $object
  910.      * @param mixed  $value
  911.      */
  912.     private function setValue($objectstring $attributeName$value)
  913.     {
  914.         try {
  915.             $this->propertyAccessor->setValue($object$attributeName$value);
  916.         } catch (NoSuchPropertyException $exception) {
  917.             // Properties not found are ignored
  918.         }
  919.     }
  920.     /**
  921.      * TODO: to remove in 3.0.
  922.      *
  923.      * @deprecated since 2.7
  924.      */
  925.     private function supportsPlainIdentifiers(): bool
  926.     {
  927.         return $this->allowPlainIdentifiers && null !== $this->itemDataProvider;
  928.     }
  929. }
  930. class_alias(AbstractItemNormalizer::class, \ApiPlatform\Core\Serializer\AbstractItemNormalizer::class);