refactor

soyuka · soyuka · commit ca229887fca5 · 2025-07-26T10:47:34.000+02:00
diff --git a/src/Hydra/IriTemplate.php b/src/Hydra/IriTemplate.php
@@ -14,10 +14,12 @@
 namespace ApiPlatform\Hydra;
 
 use Symfony\Component\JsonStreamer\Attribute\StreamedName;
+use Symfony\Component\Serializer\Annotation\SerializedName;
 
 final class IriTemplate
 {
     #[StreamedName('@type')]
+    #[SerializedName('@type')]
     public string $type = 'IriTemplate';
 
     public function __construct(
diff --git a/src/Hydra/IriTemplateMapping.php b/src/Hydra/IriTemplateMapping.php
@@ -14,15 +14,17 @@
 namespace ApiPlatform\Hydra;
 
 use Symfony\Component\JsonStreamer\Attribute\StreamedName;
+use Symfony\Component\Serializer\Annotation\SerializedName;
 
 class IriTemplateMapping
 {
     #[StreamedName('@type')]
+    #[SerializedName('@type')]
     public string $type = 'IriTemplateMapping';
 
     public function __construct(
         public string $variable,
-        public string $property,
+        public ?string $property,
         public bool $required = false,
     ) {
     }
diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -20,6 +20,8 @@
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\State\Util\StateOptionsTrait;
+use ApiPlatform\Hydra\State\Util\SearchHelperTrait;
+use ApiPlatform\Hydra\IriTemplate\IriTemplateMapping;
 use Psr\Container\ContainerInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
@@ -35,6 +37,7 @@ final class CollectionFiltersNormalizer implements NormalizerInterface, Normaliz
 {
     use HydraPrefixTrait;
     use StateOptionsTrait;
+    use SearchHelperTrait;
     private ?ContainerInterface $filterLocator = null;
 
     /**
@@ -105,7 +108,13 @@ public function normalize(mixed $object, ?string $format = null, array $context
 
         if ($currentFilters || ($parameters && \count($parameters))) {
             $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);
-            $data[$hydraPrefix.'search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters, $parameters, $hydraPrefix);
+            ['mapping' => $mapping, 'keys' => $keys] = $this->getSearchMappingAndKeys($operation, $resourceClass, $currentFilters, $parameters, [$this, 'getFilter']);
+            $data[$hydraPrefix.'search'] = [
+                '@type' => $hydraPrefix.'IriTemplate',
+                $hydraPrefix.'template' => \sprintf('%s{?%s}', $requestParts['path'], implode(',', $keys)),
+                $hydraPrefix.'variableRepresentation' => 'BasicRepresentation',
+                $hydraPrefix.'mapping' => $this->convertMappingToArray($mapping),
+            ];
         }
 
         return $data;
@@ -122,88 +131,28 @@ public function setNormalizer(NormalizerInterface $normalizer): void
     }
 
     /**
-     * Returns the content of the Hydra search property.
+     * @param IriTemplateMapping[] $mapping
      *
-     * @param FilterInterface[] $filters
+     * @return array<array<string, mixed>>
      */
-    private function getSearch(string $resourceClass, array $parts, array $filters, ?Parameters $parameters, string $hydraPrefix): array
+    private function convertMappingToArray(array $mapping): array
     {
-        $variables = [];
-        $mapping = [];
-        foreach ($filters as $filter) {
-            foreach ($filter->getDescription($resourceClass) as $variable => $data) {
-                $variables[] = $variable;
-                $mapping[] = ['@type' => 'IriTemplateMapping', 'variable' => $variable, 'property' => $data['property'] ?? null, 'required' => $data['required'] ?? false];
-            }
-        }
-
-        foreach ($parameters ?? [] as $key => $parameter) {
-            // Each IriTemplateMapping maps a variable used in the template to a property
-            if (!$parameter instanceof QueryParameterInterface || false === $parameter->getHydra()) {
-                continue;
-            }
-
-            if (($filterId = $parameter->getFilter()) && \is_string($filterId) && ($filter = $this->getFilter($filterId))) {
-                $filterDescription = $filter->getDescription($resourceClass);
-
-                foreach ($filterDescription as $variable => $description) {
-                    // // This is a practice induced by PHP and is not necessary when implementing URI template
-                    if (str_ends_with((string) $variable, '[]')) {
-                        continue;
-                    }
-
-                    if (!($descriptionProperty = $description['property'] ?? null)) {
-                        continue;
-                    }
-
-                    if (($prop = $parameter->getProperty()) && $descriptionProperty !== $prop) {
-                        continue;
-                    }
-
-                    // :property is a pattern allowed when defining parameters
-                    $k = str_replace(':property', $descriptionProperty, $key);
-                    $variable = str_replace($descriptionProperty, $k, $variable);
-                    $variables[] = $variable;
-                    $m = ['@type' => 'IriTemplateMapping', 'variable' => $variable, 'property' => $descriptionProperty];
-                    if (null !== ($required = $parameter->getRequired() ?? $description['required'] ?? null)) {
-                        $m['required'] = $required;
-                    }
-                    $mapping[] = $m;
-                }
-
-                if ($filterDescription) {
-                    continue;
-                }
+        $convertedMapping = [];
+        foreach ($mapping as $m) {
+            $converted = [
+                '@type' => 'IriTemplateMapping',
+                'variable' => $m->getVariable(),
+                'property' => $m->getProperty(),
+            ];
+
+            if (null !== $m->isRequired()) {
+                $converted['required'] = $m->isRequired();
             }
 
-            if (str_contains($key, ':property') && $parameter->getProperties()) {
-                $required = $parameter->getRequired();
-                foreach ($parameter->getProperties() as $prop) {
-                    $k = str_replace(':property', $prop, $key);
-                    $m = ['@type' => 'IriTemplateMapping', 'variable' => $k, 'property' => $prop];
-                    $variables[] = $k;
-                    if (null !== $required) {
-                        $m['required'] = $required;
-                    }
-                    $mapping[] = $m;
-                }
-
-                continue;
-            }
-
-            if (!($property = $parameter->getProperty())) {
-                continue;
-            }
-
-            $m = ['@type' => 'IriTemplateMapping', 'variable' => $key, 'property' => $property];
-            $variables[] = $key;
-            if (null !== ($required = $parameter->getRequired())) {
-                $m['required'] = $required;
-            }
-            $mapping[] = $m;
+            $convertedMapping[] = $converted;
         }
 
-        return ['@type' => $hydraPrefix.'IriTemplate', $hydraPrefix.'template' => \sprintf('%s{?%s}', $parts['path'], implode(',', $variables)), $hydraPrefix.'variableRepresentation' => 'BasicRepresentation', $hydraPrefix.'mapping' => $mapping];
+        return $convertedMapping;
     }
 
     /**
diff --git a/src/Hydra/Serializer/PartialCollectionViewNormalizer.php b/src/Hydra/Serializer/PartialCollectionViewNormalizer.php
@@ -20,6 +20,8 @@
 use ApiPlatform\Metadata\Util\IriHelper;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use ApiPlatform\State\Pagination\PartialPaginatorInterface;
+use ApiPlatform\Hydra\State\Util\PaginationHelperTrait;
+use ApiPlatform\Hydra\PartialCollectionView;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
@@ -35,6 +37,7 @@
 final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface
 {
     use HydraPrefixTrait;
+    use PaginationHelperTrait;
     private readonly PropertyAccessorInterface $propertyAccessor;
 
     /**
@@ -60,21 +63,11 @@ public function normalize(mixed $object, ?string $format = null, array $context
             throw new UnexpectedValueException('Expected data to be an array');
         }
 
-        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;
-        if ($paginated = ($object instanceof PartialPaginatorInterface)) {
-            if ($object instanceof PaginatorInterface) {
-                $paginated = 1. !== $lastPage = $object->getLastPage();
-            } else {
-                $itemsPerPage = $object->getItemsPerPage();
-                $pageTotalItems = (float) \count($object);
-            }
-
-            $currentPage = $object->getCurrentPage();
+        $paginated = ($object instanceof PartialPaginatorInterface);
+        if ($paginated && $object instanceof PaginatorInterface) {
+            $paginated = 1. !== $object->getLastPage();
         }
 
-        // TODO: This needs to be changed as well as I wrote in the CollectionFiltersNormalizer
-        // We should not rely on the request_uri but instead rely on the UriTemplate
-        // This needs that we implement the RFC and that we do more parsing before calling the serialization (MainController)
         $parsed = IriHelper::parseIri($context['uri'] ?? $context['request_uri'] ?? '/', $this->pageParameterName);
         $appliedFilters = $parsed['parameters'];
         unset($appliedFilters[$this->enabledParameterName]);
@@ -94,18 +87,35 @@ public function normalize(mixed $object, ?string $format = null, array $context
         $isPaginatedWithCursor = (bool) $cursorPaginationAttribute;
 
         $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext);
-        $data[$hydraPrefix.'view'] = ['@id' => null, '@type' => $hydraPrefix.'PartialCollectionView'];
 
         if ($isPaginatedWithCursor) {
+            $data[$hydraPrefix.'view'] = ['@id' => null, '@type' => $hydraPrefix.'PartialCollectionView'];
+
             return $this->populateDataWithCursorBasedPagination($data, $parsed, $object, $cursorPaginationAttribute, $operation?->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy, $hydraPrefix);
         }
 
-        $data[$hydraPrefix.'view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $operation?->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy);
+        $partialCollectionView = $this->getPartialCollectionView($object, $context['uri'] ?? $context['request_uri'] ?? '/', $this->pageParameterName, $this->enabledParameterName, $operation?->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy);
+
+        $view = [
+            '@id' => $partialCollectionView->id,
+            '@type' => $hydraPrefix.'PartialCollectionView',
+        ];
+
+        if (null !== $partialCollectionView->first) {
+            $view[$hydraPrefix.'first'] = $partialCollectionView->first;
+            $view[$hydraPrefix.'last'] = $partialCollectionView->last;
+        }
 
-        if ($paginated) {
-            return $this->populateDataWithPagination($data, $parsed, $currentPage, $lastPage, $itemsPerPage, $pageTotalItems, $operation?->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy, $hydraPrefix);
+        if (null !== $partialCollectionView->previous) {
+            $view[$hydraPrefix.'previous'] = $partialCollectionView->previous;
         }
 
+        if (null !== $partialCollectionView->next) {
+            $view[$hydraPrefix.'next'] = $partialCollectionView->next;
+        }
+
+        $data[$hydraPrefix.'view'] = $view;
+
         return $data;
     }
 
@@ -168,22 +178,4 @@ private function populateDataWithCursorBasedPagination(array $data, array $parse
 
         return $data;
     }
-
-    private function populateDataWithPagination(array $data, array $parsed, ?float $currentPage, ?float $lastPage, ?float $itemsPerPage, ?float $pageTotalItems, ?int $urlGenerationStrategy, string $hydraPrefix): array
-    {
-        if (null !== $lastPage) {
-            $data[$hydraPrefix.'view'][$hydraPrefix.'first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);
-            $data[$hydraPrefix.'view'][$hydraPrefix.'last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);
-        }
-
-        if (1. !== $currentPage) {
-            $data[$hydraPrefix.'view'][$hydraPrefix.'previous'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);
-        }
-
-        if ((null !== $lastPage && $currentPage < $lastPage) || (null === $lastPage && $pageTotalItems >= $itemsPerPage)) {
-            $data[$hydraPrefix.'view'][$hydraPrefix.'next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);
-        }
-
-        return $data;
-    }
 }
diff --git a/src/Hydra/State/JsonStreamerProcessor.php b/src/Hydra/State/JsonStreamerProcessor.php
@@ -27,14 +27,15 @@
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Metadata\Util\IriHelper;
+use ApiPlatform\State\Util\HttpResponseStatusTrait;
 use ApiPlatform\State\Pagination\PaginatorInterface;
-use ApiPlatform\State\Pagination\PartialPaginatorInterface;
 use ApiPlatform\State\ProcessorInterface;
 use ApiPlatform\State\Util\HttpResponseHeadersTrait;
-use ApiPlatform\State\Util\HttpResponseStatusTrait;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\JsonStreamer\StreamWriterInterface;
+use ApiPlatform\Hydra\State\Util\PaginationHelperTrait;
+use ApiPlatform\Hydra\State\Util\SearchHelperTrait;
 use Symfony\Component\TypeInfo\Type;
 
 /**
@@ -44,6 +45,8 @@ final class JsonStreamerProcessor implements ProcessorInterface
 {
     use HttpResponseHeadersTrait;
     use HttpResponseStatusTrait;
+    use PaginationHelperTrait;
+    use SearchHelperTrait;
 
     /**
      * @param ProcessorInterface<mixed,mixed>            $processor
@@ -86,7 +89,8 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
             $collection->view = $this->getView($data, $requestUri, $operation);
 
             if ($operation->getParameters()) {
-                $collection->search = $this->getSearch($operation, $requestUri);
+                $parts = parse_url($requestUri);
+                $collection->search = $this->getSearch($parts['path'] ?? '', $operation);
             }
 
             if ($data instanceof PaginatorInterface) {
@@ -119,81 +123,8 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
         return $this->processor->process($response, $operation, $uriVariables, $context);
     }
 
-    // TODO: These come from our Hydra collection normalizer, try to share the logic
-    private function getSearch(Operation $operation, string $requestUri): IriTemplate
-    {
-        /** @var list<IriTemplateMapping> */
-        $mapping = [];
-        $keys = [];
-
-        foreach ($operation->getParameters() ?? [] as $key => $parameter) {
-            if (!$parameter instanceof QueryParameterInterface || false === $parameter->getHydra()) {
-                continue;
-            }
-
-            if (!($property = $parameter->getProperty())) {
-                continue;
-            }
-
-            $keys[] = $key;
-            $m = new IriTemplateMapping(
-                variable: $key,
-                property: $property,
-                required: $parameter->getRequired() ?? false
-            );
-            $mapping[] = $m;
-        }
-
-        $parts = parse_url($requestUri);
-
-        return new IriTemplate(
-            variableRepresentation: 'BasicRepresentation',
-            mapping: $mapping,
-            template: \sprintf('%s{?%s}', $parts['path'] ?? '', implode(',', $keys)),
-        );
-    }
-
     private function getView(mixed $object, string $requestUri, Operation $operation): PartialCollectionView
     {
-        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;
-        if ($paginated = ($object instanceof PartialPaginatorInterface)) {
-            if ($object instanceof PaginatorInterface) {
-                $paginated = 1. !== $lastPage = $object->getLastPage();
-            } else {
-                $itemsPerPage = $object->getItemsPerPage();
-                $pageTotalItems = (float) \count($object);
-            }
-
-            $currentPage = $object->getCurrentPage();
-        }
-
-        // TODO: This needs to be changed as well as I wrote in the CollectionFiltersNormalizer
-        // We should not rely on the request_uri but instead rely on the UriTemplate
-        // This needs that we implement the RFC and that we do more parsing before calling the serialization (MainController)
-        $parsed = IriHelper::parseIri($requestUri, $this->pageParameterName);
-        $appliedFilters = $parsed['parameters'];
-        unset($appliedFilters[$this->enabledParameterName]);
-
-        $urlGenerationStrategy = $operation->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy;
-        $id = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $urlGenerationStrategy);
-        if (!$appliedFilters && !$paginated) {
-            return new PartialCollectionView($id);
-        }
-
-        $first = $last = $previous = $next = null;
-        if (null !== $lastPage) {
-            $first = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);
-            $last = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);
-        }
-
-        if (1. !== $currentPage) {
-            $previous = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);
-        }
-
-        if ((null !== $lastPage && $currentPage < $lastPage) || (null === $lastPage && $pageTotalItems >= $itemsPerPage)) {
-            $next = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);
-        }
-
-        return new PartialCollectionView($id, $first, $last, $previous, $next);
+        return $this->getPartialCollectionView($object, $requestUri, $this->pageParameterName, $this->enabledParameterName, $operation->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy);
     }
 }
diff --git a/src/Hydra/State/Util/PaginationHelperTrait.php b/src/Hydra/State/Util/PaginationHelperTrait.php
diff --git a/src/Hydra/State/Util/SearchHelperTrait.php b/src/Hydra/State/Util/SearchHelperTrait.php
