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

  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\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  20. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  21. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  22. use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
  23. use ApiPlatform\JsonLd\ContextBuilderInterface;
  24. use ApiPlatform\Metadata\HttpOperation;
  25. use ApiPlatform\Serializer\AbstractItemNormalizer;
  26. use ApiPlatform\Serializer\ContextTrait;
  27. use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
  28. use ApiPlatform\Util\ClassInfoTrait;
  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.     private $contextBuilder;
  50.     public function __construct($resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, ResourceClassResolverInterface $resourceClassResolver, ContextBuilderInterface $contextBuilder, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], iterable $dataTransformers = [], ResourceAccessCheckerInterface $resourceAccessChecker = null)
  51.     {
  52.         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, null, false, $defaultContext, $dataTransformers, $resourceMetadataFactory, $resourceAccessChecker);
  54.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  55.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  56.         }
  58.         $this->contextBuilder = $contextBuilder;
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function supportsNormalization($data, $format = null, array $context = []): bool
  65.     {
  66.         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      *
  72.      * @throws LogicException
  73.      *
  74.      * @return array|string|int|float|bool|\ArrayObject|null
  75.      */
  76.     public function normalize($object, $format = null, array $context = [])
  77.     {
  78.         $resourceClass = $this->getObjectClass($object);
  80.         if ($outputClass = $this->getOutputClass($resourceClass, $context) && !isset($context[self::IS_TRANSFORMED_TO_SAME_CLASS])) {
  81.             return parent::normalize($object, $format, $context);
  82.         }
  84.         // 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
  85.         $previousResourceClass = $context['resource_class'] ?? null;
  86.         $metadata = [];
  87.         if ($isResourceClass = $this->resourceClassResolver->isResourceClass($resourceClass)) {
  88.             $resourceClass = $this->resourceClassResolver->getResourceClass($object, $resourceClass);
  89.             $context = $this->initContext($resourceClass, $context);
  90.             $metadata = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
  91.         } elseif ($this->contextBuilder instanceof AnonymousContextBuilderInterface) {
  92.             if ($context['api_collection_sub_level'] ?? false) {
  93.                 unset($context['api_collection_sub_level']);
  94.                 $context['output']['genid'] = true;
  95.                 $context['output']['iri'] = null;
  96.             }
  98.             // We should improve what's behind the context creation, its probably more complicated then it should
  99.             $metadata = $this->createJsonLdContext($this->contextBuilder, $object, $context);
  100.         }
  102.         if (isset($context['operation']) && $previousResourceClass !== $resourceClass) {
  103.             unset($context['operation'], $context['operation_name']);
  104.         }
  106.         if ($this->iriConverter instanceof LegacyIriConverterInterface) {
  107.             $iri = $this->iriConverter->getIriFromItem($object);
  108.         } else {
  109.             $iri = $this->iriConverter->getIriFromResource($object, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
  110.         }
  112.         if (isset($iri)) {
  113.             $context['iri'] = $iri;
  114.             $metadata['@id'] = $iri;
  115.         }
  117.         $context['api_normalize'] = true;
  119.         $data = parent::normalize($object, $format, $context);
  120.         if (!\is_array($data)) {
  121.             return $data;
  122.         }
  124.         // TODO: remove in 3.0
  125.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  126.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  127.             $metadata['@type'] = $resourceMetadata->getIri() ?: $resourceMetadata->getShortName();
  128.         } elseif ($this->resourceMetadataFactory) {
  129.             $operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  130.             $types = $operation instanceof HttpOperation ? $operation->getTypes() : null;
  131.             if (null === $types) {
  132.                 $types = [$operation->getShortName()];
  133.             }
  134.             $metadata['@type'] = 1 === \count($types) ? $types[0] : $types;
  135.         }
  137.         return $metadata + $data;
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
  144.     {
  145.         return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format, $context);
  146.     }
  148.     /**
  149.      * {@inheritdoc}
  150.      *
  151.      * @throws NotNormalizableValueException
  152.      *
  153.      * @return mixed
  154.      */
  155.     public function denormalize($data, $class, $format = null, array $context = [])
  156.     {
  157.         // Avoid issues with proxies if we populated the object
  158.         if (isset($data['@id']) && !isset($context[self::OBJECT_TO_POPULATE])) {
  159.             if (true !== ($context['api_allow_update'] ?? true)) {
  160.                 throw new NotNormalizableValueException('Update is not allowed for this operation.');
  161.             }
  163.             $context[self::OBJECT_TO_POPULATE] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getItemFromIri($data['@id'], $context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($data['@id'], $context + ['fetch_data' => true]);
  164.         }
  166.         return parent::denormalize($data, $class, $format, $context);
  167.     }
  168. }
  170. class_alias(ItemNormalizer::class, \ApiPlatform\Core\JsonLd\Serializer\ItemNormalizer::class);