vendor/api-platform/core/src/Serializer/ItemNormalizer.php line 45

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\UrlGeneratorInterface;
  18. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  19. use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
  20. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  21. use ApiPlatform\Exception\InvalidArgumentException;
  22. use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
  23. use Psr\Log\LoggerInterface;
  24. use Psr\Log\NullLogger;
  25. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  26. use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
  27. use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
  28. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  30. /**
  31. * Generic item normalizer.
  32. *
  33. * @author Kévin Dunglas <dunglas@gmail.com>
  34. */
  35. class ItemNormalizer extends AbstractItemNormalizer
  36. {
  37. private $logger;
  39. /**
  40. * @param mixed $propertyMetadataFactory
  41. * @param LegacyIriConverterInterface|IriConverterInterface $iriConverter
  42. * @param mixed $resourceClassResolver
  43. * @param mixed|null $resourceMetadataFactory
  44. */
  45. public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null, iterable $dataTransformers = [], $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null, array $defaultContext = [])
  46. {
  47. parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers, $defaultContext, $dataTransformers, $resourceMetadataFactory, $resourceAccessChecker);
  49. $this->logger = $logger ?: new NullLogger();
  50. }
  52. /**
  53. * {@inheritdoc}
  54. *
  55. * @throws NotNormalizableValueException
  56. *
  57. * @return mixed
  58. */
  59. public function denormalize($data, $class, $format = null, array $context = [])
  60. {
  61. // Avoid issues with proxies if we populated the object
  62. if (isset($data['id']) && !isset($context[self::OBJECT_TO_POPULATE])) {
  63. if (isset($context['api_allow_update']) && true !== $context['api_allow_update']) {
  64. throw new NotNormalizableValueException('Update is not allowed for this operation.');
  65. }
  67. if (isset($context['resource_class'])) {
  68. $this->updateObjectToPopulate($data, $context);
  69. } else {
  70. // See https://github.com/api-platform/core/pull/2326 to understand this message.
  71. $this->logger->warning('The "resource_class" key is missing from the context.', [
  72. 'context' => $context,
  73. ]);
  74. }
  75. }
  77. return parent::denormalize($data, $class, $format, $context);
  78. }
  80. private function updateObjectToPopulate(array $data, array &$context): void
  81. {
  82. try {
  83. $context[self::OBJECT_TO_POPULATE] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getItemFromIri((string) $data['id'], $context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri((string) $data['id'], $context + ['fetch_data' => true]);
  84. } catch (InvalidArgumentException $e) {
  85. if ($this->iriConverter instanceof LegacyIriConverterInterface) {
  86. // remove in 3.0
  87. $identifier = null;
  88. $options = $this->getFactoryOptions($context);
  90. foreach ($this->propertyNameCollectionFactory->create($context['resource_class'], $options) as $propertyName) {
  91. if (true === $this->propertyMetadataFactory->create($context['resource_class'], $propertyName)->isIdentifier()) {
  92. $identifier = $propertyName;
  93. break;
  94. }
  95. }
  97. if (null === $identifier) {
  98. throw $e;
  99. }
  100. $iri = sprintf('%s/%s', $this->iriConverter->getIriFromResourceClass($context['resource_class']), $data[$identifier]);
  101. } else {
  102. $operation = $this->resourceMetadataFactory->create($context['resource_class'])->getOperation();
  103. // todo: we could guess uri variables with the operation and the data instead of hardcoding id
  104. $iri = $this->iriConverter->getIriFromResource($context['resource_class'], UrlGeneratorInterface::ABS_PATH, $operation, ['uri_variables' => ['id' => $data['id']]]);
  105. }
  107. $context[self::OBJECT_TO_POPULATE] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getItemFromIri($iri, ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($iri, ['fetch_data' => true]);
  108. }
  109. }
  110. }
  112. class_alias(ItemNormalizer::class, \ApiPlatform\Core\Serializer\ItemNormalizer::class);