Makes url generation strategy default value configurable

Author: antograssiot

src/Api/UrlGeneratorInterface.php

@@ -31,6 +31,11 @@
  */
 interface UrlGeneratorInterface
 {
+    /**
+     * Allow to generate url using the globally configured strategy.
+     */
+    public const DEFAULT = null;
+
     /**
      * Generates an absolute URL, e.g. "http://example.com/dir/file".
      */

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -173,6 +173,7 @@ private function handleConfig(ContainerBuilder $container, array $config, array
         $container->setParameter('api_platform.description', $config['description']);
         $container->setParameter('api_platform.version', $config['version']);
         $container->setParameter('api_platform.show_webby', $config['show_webby']);
+        $container->setParameter('api_platform.url_generation_strategy', $config['url_generation_strategy']);
         $container->setParameter('api_platform.exception_to_status', $config['exception_to_status']);
         $container->setParameter('api_platform.formats', $formats);
         $container->setParameter('api_platform.error_formats', $errorFormats);

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection;
 
+use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\DocumentMetadata;
 use ApiPlatform\Core\Exception\FilterValidationException;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
@@ -250,7 +251,10 @@ public function getConfigTreeBuilder()
                 ->arrayNode('messenger')
                     ->{interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
                 ->end()
-
+                ->integerNode('url_generation_strategy')
+                    ->defaultValue(UrlGeneratorInterface::ABS_PATH)
+                    ->info('The default URL generation strategy')
+                ->end()
                 ->arrayNode('elasticsearch')
                     ->canBeEnabled()
                     ->addDefaultsIfNotSet()

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -61,6 +61,7 @@
             <argument type="service" id="api_platform.identifiers_extractor.cached" />
             <argument type="service" id="api_platform.subresource_data_provider" on-invalid="ignore" />
             <argument type="service" id="api_platform.identifier.converter" on-invalid="ignore" />
+            <argument>%api_platform.url_generation_strategy%</argument>
         </service>
         <service id="ApiPlatform\Core\Api\IriConverterInterface" alias="api_platform.iri_converter" />
 

src/Bridge/Symfony/Bundle/Resources/config/hal.xml

@@ -15,6 +15,7 @@
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="api_platform.iri_converter" />
             <argument type="service" id="api_platform.router" />
+            <argument>%api_platform.url_generation_strategy%</argument>
 
             <tag name="serializer.normalizer" priority="-800" />
         </service>

src/Bridge/Symfony/Bundle/Resources/config/hydra.xml

@@ -14,6 +14,7 @@
             <argument type="service" id="api_platform.router" />
             <argument type="service" id="api_platform.subresource_operation_factory" />
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
+            <argument>%api_platform.url_generation_strategy%</argument>
 
             <tag name="serializer.normalizer" priority="-800" />
         </service>
@@ -33,6 +34,7 @@
             <argument type="service" id="api_platform.router" />
             <argument>%api_platform.validator.serialize_payload_fields%</argument>
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
+            <argument>%api_platform.url_generation_strategy%</argument>
 
             <tag name="serializer.normalizer" priority="-780" />
         </service>
@@ -48,6 +50,8 @@
         <service id="api_platform.hydra.normalizer.error" class="ApiPlatform\Core\Hydra\Serializer\ErrorNormalizer" public="false">
             <argument type="service" id="api_platform.router" />
             <argument>%kernel.debug%</argument>
+            <argument type="collection" />
+            <argument>%api_platform.url_generation_strategy%</argument>
 
             <tag name="serializer.normalizer" priority="-800" />
         </service>

src/Bridge/Symfony/Routing/IriConverter.php

@@ -48,15 +48,17 @@ final class IriConverter implements IriConverterInterface
     private $routeNameResolver;
     private $router;
     private $identifiersExtractor;
+    private $urlGenerationStrategy;
 
-    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null, SubresourceDataProviderInterface $subresourceDataProvider = null, IdentifierConverterInterface $identifierConverter = null)
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ItemDataProviderInterface $itemDataProvider, RouteNameResolverInterface $routeNameResolver, RouterInterface $router, PropertyAccessorInterface $propertyAccessor = null, IdentifiersExtractorInterface $identifiersExtractor = null, SubresourceDataProviderInterface $subresourceDataProvider = null, IdentifierConverterInterface $identifierConverter = null, int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         $this->itemDataProvider = $itemDataProvider;
         $this->routeNameResolver = $routeNameResolver;
         $this->router = $router;
         $this->identifiersExtractor = $identifiersExtractor;
         $this->subresourceDataProvider = $subresourceDataProvider;
         $this->identifierConverter = $identifierConverter;
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
 
         if (null === $identifiersExtractor) {
             @trigger_error(sprintf('Not injecting "%s" is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', IdentifiersExtractorInterface::class), E_USER_DEPRECATED);
@@ -113,7 +115,7 @@ public function getItemFromIri(string $iri, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
+    public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::DEFAULT): string
     {
         $resourceClass = $this->getObjectClass($item);
 
@@ -126,16 +128,16 @@ public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface
             ), $e->getCode(), $e);
         }
 
-        return $this->getItemIriFromResourceClass($resourceClass, $identifiers, $referenceType);
+        return $this->getItemIriFromResourceClass($resourceClass, $identifiers, UrlGeneratorInterface::DEFAULT === $referenceType ? $this->urlGenerationStrategy : $referenceType);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
+    public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::DEFAULT): string
     {
         try {
-            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], $referenceType);
+            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::COLLECTION), [], UrlGeneratorInterface::DEFAULT === $referenceType ? $this->urlGenerationStrategy : $referenceType);
         } catch (RoutingExceptionInterface $e) {
             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
         }
@@ -144,14 +146,14 @@ public function getIriFromResourceClass(string $resourceClass, int $referenceTyp
     /**
      * {@inheritdoc}
      */
-    public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
+    public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::DEFAULT): string
     {
         $routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM);
 
         try {
             $identifiers = $this->generateIdentifiersUrl($identifiers, $resourceClass);
 
-            return $this->router->generate($routeName, ['id' => implode(';', $identifiers)], $referenceType);
+            return $this->router->generate($routeName, ['id' => implode(';', $identifiers)], UrlGeneratorInterface::DEFAULT === $referenceType ? $this->urlGenerationStrategy : $referenceType);
         } catch (RoutingExceptionInterface $e) {
             throw new InvalidArgumentException(sprintf(
                 'Unable to generate an IRI for "%s".',
@@ -163,10 +165,10 @@ public function getItemIriFromResourceClass(string $resourceClass, array $identi
     /**
      * {@inheritdoc}
      */
-    public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
+    public function getSubresourceIriFromResourceClass(string $resourceClass, array $context, int $referenceType = UrlGeneratorInterface::DEFAULT): string
     {
         try {
-            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], $referenceType);
+            return $this->router->generate($this->routeNameResolver->getRouteName($resourceClass, OperationType::SUBRESOURCE, $context), $context['subresource_identifiers'], UrlGeneratorInterface::DEFAULT === $referenceType ? $this->urlGenerationStrategy : $referenceType);
         } catch (RoutingExceptionInterface $e) {
             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
         }

src/Hal/Serializer/EntrypointNormalizer.php

@@ -33,20 +33,22 @@ final class EntrypointNormalizer implements NormalizerInterface, CacheableSuppor
     private $resourceMetadataFactory;
     private $iriConverter;
     private $urlGenerator;
+    private $urlGenerationStrategy;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, IriConverterInterface $iriConverter, UrlGeneratorInterface $urlGenerator)
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, IriConverterInterface $iriConverter, UrlGeneratorInterface $urlGenerator, int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->iriConverter = $iriConverter;
         $this->urlGenerator = $urlGenerator;
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
     }
 
     /**
      * {@inheritdoc}
      */
     public function normalize($object, $format = null, array $context = [])
     {
-        $entrypoint = ['_links' => ['self' => ['href' => $this->urlGenerator->generate('api_entrypoint')]]];
+        $entrypoint = ['_links' => ['self' => ['href' => $this->urlGenerator->generate('api_entrypoint', [], $this->urlGenerationStrategy)]]];
 
         foreach ($object->getResourceNameCollection() as $resourceClass) {
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

src/Hydra/Serializer/ConstraintViolationListNormalizer.php

@@ -27,12 +27,14 @@ final class ConstraintViolationListNormalizer extends AbstractConstraintViolatio
     public const FORMAT = 'jsonld';
 
     private $urlGenerator;
+    private $urlGenerationStrategy;
 
-    public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)
+    public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null, int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         parent::__construct($serializePayloadFields, $nameConverter);
 
         $this->urlGenerator = $urlGenerator;
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
     }
 
     /**
@@ -43,7 +45,7 @@ public function normalize($object, $format = null, array $context = [])
         [$messages, $violations] = $this->getMessagesAndViolations($object);
 
         return [
-            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'ConstraintViolationList']),
+            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'ConstraintViolationList'], $this->urlGenerationStrategy),
             '@type' => 'ConstraintViolationList',
             'hydra:title' => $context['title'] ?? 'An error occurred',
             'hydra:description' => $messages ? implode("\n", $messages) : (string) $object,

src/Hydra/Serializer/DocumentationNormalizer.php

@@ -49,8 +49,9 @@ final class DocumentationNormalizer implements NormalizerInterface, CacheableSup
     private $urlGenerator;
     private $subresourceOperationFactory;
     private $nameConverter;
+    private $urlGenerationStrategy;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, OperationMethodResolverInterface $operationMethodResolver, UrlGeneratorInterface $urlGenerator, SubresourceOperationFactoryInterface $subresourceOperationFactory = null, NameConverterInterface $nameConverter = null)
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, OperationMethodResolverInterface $operationMethodResolver, UrlGeneratorInterface $urlGenerator, SubresourceOperationFactoryInterface $subresourceOperationFactory = null, NameConverterInterface $nameConverter = null, int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
@@ -60,6 +61,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
         $this->urlGenerator = $urlGenerator;
         $this->subresourceOperationFactory = $subresourceOperationFactory;
         $this->nameConverter = $nameConverter;
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
     }
 
     /**
@@ -499,7 +501,7 @@ private function getProperty(PropertyMetadata $propertyMetadata, string $propert
      */
     private function computeDoc(Documentation $object, array $classes): array
     {
-        $doc = ['@context' => $this->getContext(), '@id' => $this->urlGenerator->generate('api_doc', ['_format' => self::FORMAT]), '@type' => 'hydra:ApiDocumentation'];
+        $doc = ['@context' => $this->getContext(), '@id' => $this->urlGenerator->generate('api_doc', ['_format' => self::FORMAT], $this->urlGenerationStrategy), '@type' => 'hydra:ApiDocumentation'];
 
         if ('' !== $object->getTitle()) {
             $doc['hydra:title'] = $object->getTitle();
@@ -509,7 +511,7 @@ private function computeDoc(Documentation $object, array $classes): array
             $doc['hydra:description'] = $object->getDescription();
         }
 
-        $doc['hydra:entrypoint'] = $this->urlGenerator->generate('api_entrypoint');
+        $doc['hydra:entrypoint'] = $this->urlGenerator->generate('api_entrypoint', [], $this->urlGenerationStrategy);
         $doc['hydra:supportedClass'] = $classes;
 
         return $doc;

src/Hydra/Serializer/EntrypointNormalizer.php

@@ -33,12 +33,14 @@ final class EntrypointNormalizer implements NormalizerInterface, CacheableSuppor
     private $resourceMetadataFactory;
     private $iriConverter;
     private $urlGenerator;
+    private $urlGenerationStrategy;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, IriConverterInterface $iriConverter, UrlGeneratorInterface $urlGenerator)
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, IriConverterInterface $iriConverter, UrlGeneratorInterface $urlGenerator, int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->iriConverter = $iriConverter;
         $this->urlGenerator = $urlGenerator;
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
     }
 
     /**
@@ -47,8 +49,8 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     public function normalize($object, $format = null, array $context = [])
     {
         $entrypoint = [
-            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Entrypoint']),
-            '@id' => $this->urlGenerator->generate('api_entrypoint'),
+            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Entrypoint'], $this->urlGenerationStrategy),
+            '@id' => $this->urlGenerator->generate('api_entrypoint', [], $this->urlGenerationStrategy),
             '@type' => 'Entrypoint',
         ];
 

src/Hydra/Serializer/ErrorNormalizer.php

@@ -35,12 +35,14 @@ final class ErrorNormalizer implements NormalizerInterface, CacheableSupportsMet
     private $urlGenerator;
     private $debug;
     private $defaultContext = [self::TITLE => 'An error occurred'];
+    private $urlGenerationStrategy;
 
-    public function __construct(UrlGeneratorInterface $urlGenerator, bool $debug = false, array $defaultContext = [])
+    public function __construct(UrlGeneratorInterface $urlGenerator, bool $debug = false, array $defaultContext = [], int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH)
     {
         $this->urlGenerator = $urlGenerator;
         $this->debug = $debug;
         $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
+        $this->urlGenerationStrategy = $urlGenerationStrategy;
     }
 
     /**
@@ -49,7 +51,7 @@ public function __construct(UrlGeneratorInterface $urlGenerator, bool $debug = f
     public function normalize($object, $format = null, array $context = [])
     {
         $data = [
-            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Error']),
+            '@context' => $this->urlGenerator->generate('api_jsonld_context', ['shortName' => 'Error'], $this->urlGenerationStrategy),
             '@type' => 'hydra:Error',
             'hydra:title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
             'hydra:description' => $this->getErrorMessage($object, $context, $this->debug),