vendor/api-platform/core/src/JsonApi/Serializer/EntrypointNormalizer.php line 55

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\JsonApi\Serializer;
  16. use ApiPlatform\Api\Entrypoint;
  17. use ApiPlatform\Api\IriConverterInterface;
  18. use ApiPlatform\Api\UrlGeneratorInterface;
  19. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  20. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  21. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  22. use ApiPlatform\Exception\InvalidArgumentException;
  23. use ApiPlatform\Metadata\CollectionOperationInterface;
  24. use ApiPlatform\Metadata\HttpOperation;
  25. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  26. use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
  27. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  28. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  30. /**
  31.  * Normalizes the API entrypoint.
  32.  *
  33.  * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  34.  * @author Kévin Dunglas <dunglas@gmail.com>
  35.  */
  36. final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  37. {
  38.     public const FORMAT = 'jsonapi';
  40.     private $resourceMetadataFactory;
  41.     private $iriConverter;
  42.     private $urlGenerator;
  44.     public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
  45.     {
  46.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  47.         $this->iriConverter = $iriConverter;
  48.         $this->urlGenerator = $urlGenerator;
  50.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  51.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  52.         }
  54.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  55.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  56.         }
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      *
  62.      * @return array|string|int|float|bool|\ArrayObject|null
  63.      */
  64.     public function normalize($object, $format = null, array $context = [])
  65.     {
  66.         $entrypoint = ['links' => ['self' => $this->urlGenerator->generate('api_entrypoint', [], UrlGeneratorInterface::ABS_URL)]];
  68.         foreach ($object->getResourceNameCollection() as $resourceClass) {
  69.             /** @var ResourceMetadata|ResourceMetadataCollection */
  70.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  72.             if ($resourceMetadata instanceof ResourceMetadata) {
  73.                 if (!$resourceMetadata->getCollectionOperations()) {
  74.                     continue;
  75.                 }
  77.                 try {
  78.                     $entrypoint['links'][lcfirst($resourceMetadata->getShortName())] = $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);
  79.                 } catch (InvalidArgumentException $ex) {
  80.                     // Ignore resources without GET operations
  81.                 }
  82.             }
  84.             foreach ($resourceMetadata as $resource) {
  85.                 foreach ($resource->getOperations() as $operationName => $operation) {
  86.                     if (!$operation instanceof CollectionOperationInterface || ($operation instanceof HttpOperation && $operation->getUriVariables())) {
  87.                         continue;
  88.                     }
  90.                     try {
  91.                         if ($this->iriConverter instanceof LegacyIriConverterInterface) {
  92.                             $iri = $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);
  93.                         } else {
  94.                             $iri = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_URL, $operation);
  95.                         }
  97.                         $entrypoint['links'][lcfirst($resource->getShortName())] = $iri;
  98.                     } catch (InvalidArgumentException $ex) {
  99.                         // Ignore resources without GET operations
  100.                     }
  101.                 }
  102.             }
  103.         }
  105.         return $entrypoint;
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function supportsNormalization($data, $format = null, array $context = []): bool
  112.     {
  113.         return self::FORMAT === $format && $data instanceof Entrypoint;
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function hasCacheableSupportsMethod(): bool
  120.     {
  121.         return true;
  122.     }
  123. }
  125. class_alias(EntrypointNormalizer::class, \ApiPlatform\Core\JsonApi\Serializer\EntrypointNormalizer::class);