[Search] Add sorting to the saved search list endpoint

Expose sortBy (name | modificationDate) + sortOrder (ASC | DESC) query params on
GET /search/saved/configuration; sort the accessible configurations in the service
before pagination. Default order (modification date, newest first) is unchanged.

Author: markus-moser

src/Search/Controller/SavedSearch/ListConfigurationsController.php

@@ -18,6 +18,8 @@
 use Pimcore\Bundle\StudioBackendBundle\MappedParameter\CollectionParameters;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\PageParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\PageSizeParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\SortByParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\SortOrderParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\TextFieldParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Property\GenericCollection;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\Content\CollectionJson;
@@ -72,6 +74,8 @@ public function __construct(
         description: 'Optional term to filter the saved search configurations by name.',
         required: false
     )]
+    #[SortByParameter(enum: ['name', 'modificationDate'])]
+    #[SortOrderParameter]
     #[SuccessResponse(
         description: 'saved_search_get_configurations_success_response',
         content: new CollectionJson(new GenericCollection(ConfigurationListItem::class))
@@ -81,11 +85,15 @@ public function __construct(
     ])]
     public function getSavedSearchConfigurations(
         #[MapQueryParameter] ?string $searchTerm = null,
+        #[MapQueryParameter] ?string $sortBy = null,
+        #[MapQueryParameter] ?string $sortOrder = null,
         #[MapQueryString] CollectionParameters $parameters = new CollectionParameters(),
     ): JsonResponse {
         $collection = $this->savedSearchConfigurationService->listConfigurations(
             $parameters,
-            $searchTerm
+            $searchTerm,
+            $sortBy,
+            $sortOrder
         );
 
         return $this->getPaginatedCollection(

src/Search/Service/SavedSearchConfigurationService.php

@@ -36,6 +36,9 @@
 use function array_slice;
 use function array_values;
 use function count;
+use function strcasecmp;
+use function strtoupper;
+use function usort;
 
 /**
  * @internal
@@ -53,8 +56,12 @@ public function __construct(
     ) {
     }
 
-    public function listConfigurations(CollectionParameters $parameters, ?string $searchTerm): Collection
-    {
+    public function listConfigurations(
+        CollectionParameters $parameters,
+        ?string $searchTerm,
+        ?string $sortBy = null,
+        ?string $sortOrder = null,
+    ): Collection {
         $currentUser = $this->securityService->getCurrentUser();
         $userId = $currentUser->getId();
 
@@ -66,6 +73,8 @@ public function listConfigurations(CollectionParameters $parameters, ?string $se
             )
         );
 
+        $this->sortConfigurations($accessibleConfigurations, $sortBy, $sortOrder);
+
         $items = [];
         $pagedConfigurations = array_slice(
             $accessibleConfigurations,
@@ -89,6 +98,37 @@ public function listConfigurations(CollectionParameters $parameters, ?string $se
         return new Collection(count($accessibleConfigurations), $items);
     }
 
+    /**
+     * Sorts the accessible configurations in place. Without an explicit sortBy the repository's
+     * default order (modification date, newest first) is kept.
+     *
+     * @param SavedSearchConfiguration[] $configurations
+     */
+    private function sortConfigurations(array &$configurations, ?string $sortBy, ?string $sortOrder): void
+    {
+        if ($sortBy === null) {
+            return;
+        }
+
+        $descending = strtoupper((string) $sortOrder) === 'DESC';
+
+        usort(
+            $configurations,
+            static function (
+                SavedSearchConfiguration $a,
+                SavedSearchConfiguration $b
+            ) use ($sortBy, $descending): int {
+                $comparison = match ($sortBy) {
+                    'name' => strcasecmp($a->getName(), $b->getName()),
+                    'modificationDate' => $a->getModificationDate() <=> $b->getModificationDate(),
+                    default => 0,
+                };
+
+                return $descending ? -$comparison : $comparison;
+            }
+        );
+    }
+
     public function listMenuShortcutConfigurations(): Collection
     {
         $currentUser = $this->securityService->getCurrentUser();

src/Search/Service/SavedSearchConfigurationServiceInterface.php

@@ -31,7 +31,12 @@ interface SavedSearchConfigurationServiceInterface
     /**
      * @return Collection<ConfigurationListItem>
      */
-    public function listConfigurations(CollectionParameters $parameters, ?string $searchTerm): Collection;
+    public function listConfigurations(
+        CollectionParameters $parameters,
+        ?string $searchTerm,
+        ?string $sortBy = null,
+        ?string $sortOrder = null,
+    ): Collection;
 
     /**
      * @return Collection<ConfigurationListItem>