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

  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\JsonLd\Serializer;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\ResourceClassResolverInterface;
  18. use ApiPlatform\Api\UrlGeneratorInterface;
  19. use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
  20. use ApiPlatform\JsonLd\ContextBuilderInterface;
  21. use ApiPlatform\Metadata\HttpOperation;
  22. use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  23. use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  24. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  25. use ApiPlatform\Metadata\Util\ClassInfoTrait;
  26. use ApiPlatform\Serializer\AbstractItemNormalizer;
  27. use ApiPlatform\Serializer\ContextTrait;
  28. use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
  29. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  30. use Symfony\Component\Serializer\Exception\LogicException;
  31. use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
  32. use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
  33. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  35. /**
  36.  * Converts between objects and array including JSON-LD and Hydra metadata.
  37.  *
  38.  * @author Kévin Dunglas <dunglas@gmail.com>
  39.  */
  40. final class ItemNormalizer extends AbstractItemNormalizer
  41. {
  42.     use ClassInfoTrait;
  43.     use ContextTrait;
  44.     use JsonLdContextTrait;
  46.     public const FORMAT = 'jsonld';
  48.     public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, private readonly ContextBuilderInterface $contextBuilder, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceAccessCheckerInterface $resourceAccessChecker = null)
  49.     {
  50.         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $defaultContext, $resourceMetadataCollectionFactory, $resourceAccessChecker);
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  57.     {
  58.         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      *
  64.      * @throws LogicException
  65.      */
  66.     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
  67.     {
  68.         $resourceClass = $this->getObjectClass($object);
  70.         if ($this->getOutputClass($context)) {
  71.             return parent::normalize($object, $format, $context);
  72.         }
  74.         // TODO: we should not remove the resource_class in the normalizeRawCollection as we would find out anyway that it's not the same as the requested one
  75.         $previousResourceClass = $context['resource_class'] ?? null;
  76.         $metadata = [];
  77.         if ($isResourceClass = $this->resourceClassResolver->isResourceClass($resourceClass)) {
  78.             $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null);
  79.             $context = $this->initContext($resourceClass, $context);
  80.             $metadata = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
  81.         } elseif ($this->contextBuilder instanceof AnonymousContextBuilderInterface) {
  82.             if ($context['api_collection_sub_level'] ?? false) {
  83.                 unset($context['api_collection_sub_level']);
  84.                 $context['output']['genid'] = true;
  85.                 $context['output']['iri'] = null;
  86.             }
  88.             // We should improve what's behind the context creation, its probably more complicated then it should
  89.             $metadata = $this->createJsonLdContext($this->contextBuilder, $object, $context);
  90.         }
  92.         // maybe not needed anymore
  93.         if (isset($context['operation']) && $previousResourceClass !== $resourceClass) {
  94.             unset($context['operation'], $context['operation_name']);
  95.         }
  97.         if (($operation = $context['operation'] ?? null) && method_exists($operation, 'getItemUriTemplate') && ($itemUriTemplate = $operation->getItemUriTemplate())) {
  98.             $context['item_uri_template'] = $itemUriTemplate;
  99.         }
  101.         if ($iri = $this->iriConverter->getIriFromResource($object, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context)) {
  102.             $context['iri'] = $iri;
  103.             $metadata['@id'] = $iri;
  104.         }
  106.         $context['api_normalize'] = true;
  108.         $data = parent::normalize($object, $format, $context);
  109.         if (!\is_array($data)) {
  110.             return $data;
  111.         }
  113.         if (!isset($metadata['@type']) && $isResourceClass) {
  114.             $operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation();
  116.             $types = $operation instanceof HttpOperation ? $operation->getTypes() : null;
  117.             if (null === $types) {
  118.                 $types = [$operation->getShortName()];
  119.             }
  120.             $metadata['@type'] = 1 === \count($types) ? $types[0] : $types;
  121.         }
  123.         return $metadata + $data;
  124.     }
  126.     /**
  127.      * {@inheritdoc}
  128.      */
  129.     public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
  130.     {
  131.         return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format, $context);
  132.     }
  134.     /**
  135.      * {@inheritdoc}
  136.      *
  137.      * @throws NotNormalizableValueException
  138.      */
  139.     public function denormalize(mixed $data, string $class, string $format = null, array $context = []): mixed
  140.     {
  141.         // Avoid issues with proxies if we populated the object
  142.         if (isset($data['@id']) && !isset($context[self::OBJECT_TO_POPULATE])) {
  143.             if (true !== ($context['api_allow_update'] ?? true)) {
  144.                 throw new NotNormalizableValueException('Update is not allowed for this operation.');
  145.             }
  147.             $context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getResourceFromIri($data['@id'], $context + ['fetch_data' => true]);
  148.         }
  150.         return parent::denormalize($data, $class, $format, $context);
  151.     }
  152. }