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

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. /**
  59. * {@inheritdoc}
  60. */
  61. public function normalize($object, $format = null, array $context = []): array
  62. {
  63. $entrypoint = [
  64. '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Entrypoint']),
  65. '@id' => $this->urlGenerator->generate('api_entrypoint'),
  66. '@type' => 'Entrypoint',
  67. ];
  69. foreach ($object->getResourceNameCollection() as $resourceClass) {
  70. /** @var ResourceMetadata|ResourceMetadataCollection */
  71. $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
  73. if ($resourceMetadata instanceof ResourceMetadata) {
  74. if (empty($resourceMetadata->getCollectionOperations())) {
  75. continue;
  76. }
  77. try {
  78. $entrypoint[lcfirst($resourceMetadata->getShortName())] = $this->iriConverter->getIriFromResourceClass($resourceClass);
  79. } catch (InvalidArgumentException $ex) {
  80. // Ignore resources without GET operations
  81. }
  82. continue;
  83. }
  85. foreach ($resourceMetadata as $resource) {
  86. if ($resource->getExtraProperties()['is_alternate_resource_metadata'] ?? false) {
  87. continue;
  88. }
  90. foreach ($resource->getOperations() as $operationName => $operation) {
  91. $key = lcfirst($resource->getShortName());
  92. if (!$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
  93. continue;
  94. }
  96. try {
  97. $entrypoint[$key] = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass) : $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $operation);
  98. } catch (InvalidArgumentException|OperationNotFoundException $ex) {
  99. // Ignore resources without GET operations
  100. }
  101. }
  102. }
  103. }
  105. ksort($entrypoint);
  107. return $entrypoint;
  108. }
  110. /**
  111. * {@inheritdoc}
  112. */
  113. public function supportsNormalization($data, $format = null, array $context = []): bool
  114. {
  115. return self::FORMAT === $format && $data instanceof Entrypoint;
  116. }
  118. /**
  119. * {@inheritdoc}
  120. */
  121. public function hasCacheableSupportsMethod(): bool
  122. {
  123. return true;
  124. }
  125. }
  127. class_alias(EntrypointNormalizer::class, \ApiPlatform\Core\Hydra\Serializer\EntrypointNormalizer::class);