vendor/api-platform/core/src/JsonLd/ContextBuilder.php line 65

  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;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\UrlGeneratorInterface;
  18. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface as LegacyPropertyMetadataFactoryInterface;
  19. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface as LegacyPropertyNameCollectionFactoryInterface;
  20. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  21. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  22. use ApiPlatform\Metadata\ApiProperty;
  23. use ApiPlatform\Metadata\HttpOperation;
  24. use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  25. use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  26. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  27. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  28. use ApiPlatform\Util\ClassInfoTrait;
  29. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  31. /**
  32.  * {@inheritdoc}
  33.  * TODO: 3.0 simplify or remove the class.
  34.  *
  35.  * @author Kévin Dunglas <dunglas@gmail.com>
  36.  */
  37. final class ContextBuilder implements AnonymousContextBuilderInterface
  38. {
  39.     use ClassInfoTrait;
  41.     public const FORMAT = 'jsonld';
  43.     private $resourceNameCollectionFactory;
  44.     /**
  45.      * @param ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory
  46.      */
  47.     private $resourceMetadataFactory;
  48.     /**
  49.      * @var LegacyPropertyNameCollectionFactoryInterface|PropertyNameCollectionFactoryInterface
  50.      */
  51.     private $propertyNameCollectionFactory;
  52.     /**
  53.      * @var LegacyPropertyMetadataFactoryInterface|PropertyMetadataFactoryInterface
  54.      */
  55.     private $propertyMetadataFactory;
  56.     private $urlGenerator;
  58.     /**
  59.      * @var NameConverterInterface|null
  60.      */
  61.     private $nameConverter;
  63.     private $iriConverter;
  65.     public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, $resourceMetadataFactory, $propertyNameCollectionFactory, $propertyMetadataFactory, UrlGeneratorInterface $urlGenerator, NameConverterInterface $nameConverter = null, IriConverterInterface $iriConverter = null)
  66.     {
  67.         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  68.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  69.         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  70.         $this->propertyMetadataFactory = $propertyMetadataFactory;
  71.         $this->urlGenerator = $urlGenerator;
  72.         $this->nameConverter = $nameConverter;
  73.         $this->iriConverter = $iriConverter;
  75.         if ($resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  76.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  77.         }
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      */
  83.     public function getBaseContext(int $referenceType = UrlGeneratorInterface::ABS_URL): array
  84.     {
  85.         return [
  86.             '@vocab' => $this->urlGenerator->generate('api_doc', ['_format' => self::FORMAT], UrlGeneratorInterface::ABS_URL).'#',
  87.             'hydra' => self::HYDRA_NS,
  88.         ];
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function getEntrypointContext(int $referenceType = UrlGeneratorInterface::ABS_PATH): array
  95.     {
  96.         $context = $this->getBaseContext($referenceType);
  98.         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
  99.             // TODO: remove in 3.0
  100.             if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  101.                 $shortName = $this->resourceMetadataFactory->create($resourceClass)->getShortName();
  102.             } else {
  103.                 $shortName = $this->resourceMetadataFactory->create($resourceClass)[0]->getShortName();
  104.             }
  106.             $resourceName = lcfirst($shortName);
  108.             $context[$resourceName] = [
  109.                 '@id' => 'Entrypoint/'.$resourceName,
  110.                 '@type' => '@id',
  111.             ];
  112.         }
  114.         return $context;
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function getResourceContext(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): array
  121.     {
  122.         // TODO: Remove in 3.0
  123.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  124.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  125.             if (null === $shortName = $resourceMetadata->getShortName()) {
  126.                 return [];
  127.             }
  129.             if ($resourceMetadata->getAttribute('normalization_context')['iri_only'] ?? false) {
  130.                 $context = $this->getBaseContext($referenceType);
  131.                 $context['hydra:member']['@type'] = '@id';
  133.                 return $context;
  134.             }
  136.             return $this->getResourceContextWithShortname($resourceClass, $referenceType, $shortName);
  137.         }
  139.         $operation = $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  140.         if (null === $shortName = $operation->getShortName()) {
  141.             return [];
  142.         }
  144.         if ($operation->getNormalizationContext()['iri_only'] ?? false) {
  145.             $context = $this->getBaseContext($referenceType);
  146.             $context['hydra:member']['@type'] = '@id';
  148.             return $context;
  149.         }
  151.         return $this->getResourceContextWithShortname($resourceClass, $referenceType, $shortName, $operation);
  152.     }
  154.     /**
  155.      * {@inheritdoc}
  156.      */
  157.     public function getResourceContextUri(string $resourceClass, int $referenceType = null): string
  158.     {
  159.         // TODO: remove in 3.0
  160.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  161.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  162.             if (null === $referenceType) {
  163.                 $referenceType = $resourceMetadata->getAttribute('url_generation_strategy');
  164.             }
  166.             return $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $resourceMetadata->getShortName()], $referenceType);
  167.         }
  169.         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass)[0];
  170.         if (null === $referenceType) {
  171.             $referenceType = $resourceMetadata->getUrlGenerationStrategy();
  172.         }
  174.         return $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $resourceMetadata->getShortName()], $referenceType);
  175.     }
  177.     /**
  178.      * {@inheritdoc}
  179.      */
  180.     public function getAnonymousResourceContext($object, array $context = [], int $referenceType = UrlGeneratorInterface::ABS_PATH): array
  181.     {
  182.         $outputClass = $this->getObjectClass($object);
  183.         $shortName = (new \ReflectionClass($outputClass))->getShortName();
  185.         $jsonLdContext = [
  186.             '@context' => $this->getResourceContextWithShortname(
  187.                 $outputClass,
  188.                 $referenceType,
  189.                 $shortName
  190.             ),
  191.             '@type' => $shortName,
  192.         ];
  194.         if (!isset($context['iri']) || false !== $context['iri']) {
  195.             // Not using an IriConverter here is deprecated in 2.7, avoid spl_object_hash as it may collide
  196.             if (isset($this->iriConverter)) {
  197.                 $jsonLdContext['@id'] = $context['iri'] ?? $this->iriConverter->getIriFromResource($object);
  198.             } else {
  199.                 $jsonLdContext['@id'] = $context['iri'] ?? '/.well-known/genid/'.bin2hex(random_bytes(10));
  200.             }
  201.         }
  203.         if ($this->iriConverter && isset($context['gen_id']) && true === $context['gen_id']) {
  204.             $jsonLdContext['@id'] = $this->iriConverter->getIriFromResource($object);
  205.         }
  207.         if (false === ($context['iri'] ?? null)) {
  208.             trigger_deprecation('api-platform/core', '2.7', 'An anonymous resource will use a Skolem IRI in API Platform 3.0. Use #[ApiProperty(genId: false)] to keep this behavior in 3.0.');
  209.         }
  211.         if ($context['has_context'] ?? false) {
  212.             unset($jsonLdContext['@context']);
  213.         }
  215.         // here the object can be different from the resource given by the $context['api_resource'] value
  216.         if (isset($context['api_resource'])) {
  217.             if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  218.                 $jsonLdContext['@type'] = $this->resourceMetadataFactory->create($this->getObjectClass($context['api_resource']))->getShortName();
  219.             } else {
  220.                 $jsonLdContext['@type'] = $this->resourceMetadataFactory->create($this->getObjectClass($context['api_resource']))[0]->getShortName();
  221.             }
  222.         }
  224.         return $jsonLdContext;
  225.     }
  227.     private function getResourceContextWithShortname(string $resourceClass, int $referenceType, string $shortName, ?HttpOperation $operation = null): array
  228.     {
  229.         $context = $this->getBaseContext($referenceType);
  230.         if ($this->propertyMetadataFactory instanceof LegacyPropertyMetadataFactoryInterface) {
  231.             $propertyContext = [];
  232.         } else {
  233.             $propertyContext = $operation ? ['normalization_groups' => $operation->getNormalizationContext()['groups'] ?? null, 'denormalization_groups' => $operation->getDenormalizationContext()['groups'] ?? null] : ['normalization_groups' => [], 'denormalization_groups' => []];
  234.         }
  236.         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
  237.             /** @var PropertyMetadata|ApiProperty */
  238.             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName, $propertyContext);
  240.             if ($propertyMetadata->isIdentifier() && true !== $propertyMetadata->isWritable()) {
  241.                 continue;
  242.             }
  244.             $convertedName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $resourceClass, self::FORMAT) : $propertyName;
  245.             if ($propertyMetadata instanceof PropertyMetadata) {
  246.                 $jsonldContext = ($propertyMetadata->getAttributes() ?? [])['jsonld_context'] ?? [];
  247.                 $id = $propertyMetadata->getIri();
  248.             } else {
  249.                 $jsonldContext = $propertyMetadata->getJsonldContext() ?? [];
  251.                 if ($id = $propertyMetadata->getIris()) {
  252.                     $id = 1 === \count($id) ? $id[0] : $id;
  253.                 }
  254.             }
  256.             if (!$id) {
  257.                 $id = sprintf('%s/%s', $shortName, $convertedName);
  258.             }
  260.             if (false === $propertyMetadata->isReadableLink()) {
  261.                 $jsonldContext += [
  262.                     '@id' => $id,
  263.                     '@type' => '@id',
  264.                 ];
  265.             }
  267.             if (empty($jsonldContext)) {
  268.                 $context[$convertedName] = $id;
  269.             } else {
  270.                 $context[$convertedName] = $jsonldContext + [
  271.                     '@id' => $id,
  272.                 ];
  273.             }
  274.         }
  276.         return $context;
  277.     }
  278. }
  280. class_alias(ContextBuilder::class, \ApiPlatform\Core\JsonLd\ContextBuilder::class);