vendor/api-platform/core/src/Hal/Serializer/EntrypointNormalizer.php line 47

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\Hal\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\Operation;
  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 Kévin Dunglas <dunglas@gmail.com>
  34.  */
  35. final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
  36. {
  37.     public const FORMAT = 'jsonhal';
  39.     /**
  40.      * @var ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface
  41.      */
  42.     private $resourceMetadataFactory;
  43.     /** @var LegacyIriConverterInterface|IriConverterInterface */
  44.     private $iriConverter;
  45.     private $urlGenerator;
  47.     public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
  48.     {
  49.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  50.         $this->iriConverter = $iriConverter;
  51.         $this->urlGenerator = $urlGenerator;
  53.         if ($iriConverter instanceof LegacyIriConverterInterface) {
  54.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  55.         }
  57.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  58.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  59.         }
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function normalize($object, $format = null, array $context = []): array
  66.     {
  67.         $entrypoint = ['_links' => ['self' => ['href' => $this->urlGenerator->generate('api_entrypoint')]]];
  69.         foreach ($object->getResourceNameCollection() as $resourceClass) {
  70.             /** @var ResourceMetadata|ResourceMetadataCollection */
  71.             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  73.             if ($resourceMetadata instanceof ResourceMetadata) {
  74.                 if (!$resourceMetadata->getCollectionOperations()) {
  75.                     continue;
  76.                 }
  78.                 try {
  79.                     $entrypoint['_links'][lcfirst($resourceMetadata->getShortName())]['href'] = $this->iriConverter->getIriFromResourceClass($resourceClass);
  80.                 } catch (InvalidArgumentException $ex) {
  81.                     // Ignore resources without GET operations
  82.                 }
  83.             }
  85.             foreach ($resourceMetadata as $resource) {
  86.                 foreach ($resource->getOperations() as $operationName => $operation) {
  87.                     /** @var Operation $operation */
  88.                     if (!$operation instanceof CollectionOperationInterface) {
  89.                         continue;
  90.                     }
  92.                     try {
  93.                         $href = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass) : $this->iriConverter->getIriFromResource($operation->getClass(), UrlGeneratorInterface::ABS_PATH, $operation);
  94.                         $entrypoint['_links'][lcfirst($operation->getShortName())]['href'] = $href;
  95.                     } catch (InvalidArgumentException $ex) {
  96.                         // Ignore resources without GET operations
  97.                     }
  98.                 }
  99.             }
  100.         }
  102.         return $entrypoint;
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function supportsNormalization($data, $format = null, array $context = []): bool
  109.     {
  110.         return self::FORMAT === $format && $data instanceof Entrypoint;
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function hasCacheableSupportsMethod(): bool
  117.     {
  118.         return true;
  119.     }
  120. }
  122. class_alias(EntrypointNormalizer::class, \ApiPlatform\Core\Hal\Serializer\EntrypointNormalizer::class);