vendor/api-platform/core/src/Hydra/Serializer/EntrypointNormalizer.php line 42

  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\Hydra\Serializer;
  16. use ApiPlatform\Api\Entrypoint;
  17. use ApiPlatform\Api\IriConverterInterface;
  18. use ApiPlatform\Api\UrlGeneratorInterface;
  19. use ApiPlatform\Exception\InvalidArgumentException;
  20. use ApiPlatform\Exception\OperationNotFoundException;
  21. use ApiPlatform\Metadata\CollectionOperationInterface;
  22. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  23. use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
  24. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  26. /**
  27.  * Normalizes the API entrypoint.
  28.  *
  29.  * @author Kévin Dunglas <dunglas@gmail.com>
  30.  */
  31. final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  32. {
  33.     public const FORMAT = 'jsonld';
  35.     public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly IriConverterInterface $iriConverter, private readonly UrlGeneratorInterface $urlGenerator)
  36.     {
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function normalize(mixed $object, string $format = null, array $context = []): array
  43.     {
  44.         $entrypoint = [
  45.             '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Entrypoint']),
  46.             '@id' => $this->urlGenerator->generate('api_entrypoint'),
  47.             '@type' => 'Entrypoint',
  48.         ];
  50.         foreach ($object->getResourceNameCollection() as $resourceClass) {
  51.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  53.             foreach ($resourceMetadata as $resource) {
  54.                 if ($resource->getExtraProperties()['is_alternate_resource_metadata'] ?? false) {
  55.                     continue;
  56.                 }
  58.                 foreach ($resource->getOperations() as $operation) {
  59.                     $key = lcfirst($resource->getShortName());
  60.                     if (!$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
  61.                         continue;
  62.                     }
  64.                     try {
  65.                         $entrypoint[$key] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $operation); // @phpstan-ignore-line phpstan issue as type is CollectionOperationInterface & Operation
  66.                     } catch (InvalidArgumentException|OperationNotFoundException) {
  67.                         // Ignore resources without GET operations
  68.                     }
  69.                 }
  70.             }
  71.         }
  73.         ksort($entrypoint);
  75.         return $entrypoint;
  76.     }
  78.     /**
  79.      * {@inheritdoc}
  80.      */
  81.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  82.     {
  83.         return self::FORMAT === $format && $data instanceof Entrypoint;
  84.     }
  86.     public function hasCacheableSupportsMethod(): bool
  87.     {
  88.         return true;
  89.     }
  90. }