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

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\Hydra\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\Exception\OperationNotFoundException;
  24. use ApiPlatform\Metadata\CollectionOperationInterface;
  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 = 'jsonld';
  39. private $resourceMetadataFactory;
  40. private $iriConverter;
  41. private $urlGenerator;
  43. public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
  44. {
  45. if ($iriConverter instanceof LegacyIriConverterInterface) {
  46. trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
  47. }
  49. $this->iriConverter = $iriConverter;
  50. if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  51. trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  52. }
  54. $this->resourceMetadataFactory = $resourceMetadataFactory;
  55. $this->urlGenerator = $urlGenerator;
  56. }
  58. public function normalize($object, $format = null, array $context = []): array
  59. {
  60. $entrypoint = [
  61. '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Entrypoint']),
  62. '@id' => $this->urlGenerator->generate('api_entrypoint'),
  63. '@type' => 'Entrypoint',
  64. ];
  66. foreach ($object->getResourceNameCollection() as $resourceClass) {
  67. /** @var ResourceMetadata|ResourceMetadataCollection */
  68. $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  70. if ($resourceMetadata instanceof ResourceMetadata) {
  71. if (empty($resourceMetadata->getCollectionOperations())) {
  72. continue;
  73. }
  74. try {
  75. $entrypoint[lcfirst($resourceMetadata->getShortName())] = $this->iriConverter->getIriFromResourceClass($resourceClass);
  76. } catch (InvalidArgumentException $ex) {
  77. // Ignore resources without GET operations
  78. }
  79. continue;
  80. }
  82. foreach ($resourceMetadata as $resource) {
  83. if ($resource->getExtraProperties()['is_alternate_resource_metadata'] ?? false) {
  84. continue;
  85. }
  87. foreach ($resource->getOperations() as $operationName => $operation) {
  88. $key = lcfirst($resource->getShortName());
  89. if (!$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
  90. continue;
  91. }
  93. try {
  94. $entrypoint[$key] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass) : $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $operation);
  95. } catch (InvalidArgumentException|OperationNotFoundException $ex) {
  96. // Ignore resources without GET operations
  97. }
  98. }
  99. }
  100. }
  102. ksort($entrypoint);
  104. return $entrypoint;
  105. }
  107. public function supportsNormalization($data, $format = null, array $context = []): bool
  108. {
  109. return self::FORMAT === $format && $data instanceof Entrypoint;
  110. }
  112. public function hasCacheableSupportsMethod(): bool
  113. {
  114. return true;
  115. }
  116. }
  118. class_alias(EntrypointNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\EntrypointNormalizer::class);