[Classification Store] Add search term

config/classification_store.yaml

@@ -25,6 +25,9 @@ services:
   Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\KeyGroupRelationServiceInterface:
     class: Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\KeyGroupRelationService
 
+  Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\SearchHelperServiceInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\SearchHelperService
+
 
   #
   # Repositories

src/ClassificationStore/Controller/GetCollectionsController.php

@@ -93,6 +93,12 @@ public function __construct(
         required: true,
         example: 'technicalAttributes'
     )]
+    #[TextFieldParameter(
+        name: 'searchTerm',
+        description: 'Search Term',
+        required: false,
+        example: 'search term'
+    )]
     #[DefaultResponses([
         HttpResponseCodes::FORBIDDEN,
         HttpResponseCodes::UNAUTHORIZED,

src/ClassificationStore/Controller/GetGroupsController.php

@@ -85,6 +85,12 @@ public function __construct(
         namePrefix: 'object',
         required: false
     )]
+    #[TextFieldParameter(
+        name: 'searchTerm',
+        description: 'Search Term',
+        required: false,
+        example: 'search term'
+    )]
     #[PageParameter]
     #[PageSizeParameter]
     #[TextFieldParameter(

src/ClassificationStore/Controller/GetKeyGroupRelationsController.php

@@ -85,6 +85,12 @@ public function __construct(
         namePrefix: 'object',
         required: false
     )]
+    #[TextFieldParameter(
+        name: 'searchTerm',
+        description: 'Search Term',
+        required: false,
+        example: 'search term'
+    )]
     #[PageParameter]
     #[PageSizeParameter]
     #[TextFieldParameter(

src/ClassificationStore/MappedParameter/ListClassificationStoreParameter.php

@@ -34,6 +34,7 @@ public function __construct(
         #[NotBlank(message: 'The page size name must not be empty.')]
         private int $pageSize,
         private ?int $objectId = null,
+        private ?string $searchTerm = null,
     ) {
     }
 
@@ -61,4 +62,9 @@ public function getPageSize(): int
     {
         return $this->pageSize;
     }
+
+    public function getSearchTerm(): ?string
+    {
+        return $this->searchTerm;
+    }
 }

src/ClassificationStore/Repository/CollectionConfigRepository.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository;
 
+use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\SearchHelperServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\MappedParameter\CollectionParametersInterface;
 use Pimcore\Model\DataObject\Classificationstore\CollectionConfig\Listing;
 use function count;
@@ -25,13 +26,19 @@
  */
 final class CollectionConfigRepository implements CollectionConfigRepositoryInterface
 {
+    public function __construct(
+        private SearchHelperServiceInterface $searchHelperService
+    ) {
+    }
+
     /**
      * {@inheritDoc}
      */
     public function getPaginatedCollectionsByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $collectionIds = null
+        ?array $collectionIds = null,
+        ?string $searchTerm = null
     ): array {
         $list = new Listing();
 
@@ -45,6 +52,10 @@ public function getPaginatedCollectionsByStore(
             $this->applyCollectionIdsFilter($list, $collectionIds);
         }
 
+        if ($searchTerm !== null) {
+            $this->searchHelperService->applySearchTermFilter($list, $searchTerm);
+        }
+
         return $list->load();
     }
 

src/ClassificationStore/Repository/CollectionConfigRepositoryInterface.php

@@ -32,7 +32,8 @@ interface CollectionConfigRepositoryInterface
     public function getPaginatedCollectionsByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $collectionIds = null
+        ?array $collectionIds = null,
+        ?string $searchTerm = null
     ): array;
 
     public function getCountByStoreId(int $storeId): int;

src/ClassificationStore/Repository/GroupConfigRepository.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository;
 
+use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\SearchHelperServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\MappedParameter\CollectionParametersInterface;
 use Pimcore\Model\DataObject\Classificationstore\GroupConfig\Listing;
 use function count;
@@ -25,13 +26,19 @@
  */
 final class GroupConfigRepository implements GroupConfigRepositoryInterface
 {
+    public function __construct(
+        private SearchHelperServiceInterface $searchHelperService
+    ) {
+    }
+
     /**
      * {@inheritDoc}
      */
     public function getPaginatedGroupsByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $groupIds = null
+        ?array $groupIds = null,
+        ?string $searchTerm = null
     ): array {
         $listing = new Listing();
 
@@ -41,6 +48,10 @@ public function getPaginatedGroupsByStore(
         $listing->setOrderKey('id');
         $listing->setCondition('storeId = ?', $storeId);
 
+        if ($searchTerm !== null) {
+            $this->searchHelperService->applySearchTermFilter($listing, $searchTerm);
+        }
+
         if ($groupIds !== null) {
             $this->applyGroupIdsFilter($listing, $groupIds);
         }

src/ClassificationStore/Repository/GroupConfigRepositoryInterface.php

@@ -32,7 +32,8 @@ interface GroupConfigRepositoryInterface
     public function getPaginatedGroupsByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $groupIds = null
+        ?array $groupIds = null,
+        ?string $searchTerm = null
     ): array;
 
     public function getAllGroupsByStore(

src/ClassificationStore/Repository/KeyGroupRelationRepository.php

@@ -16,17 +16,21 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository;
 
+use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service\SearchHelperServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\MappedParameter\CollectionParametersInterface;
+use Pimcore\Model\DataObject\Classificationstore\GroupConfig\Dao as GroupConfigDao;
+use Pimcore\Model\DataObject\Classificationstore\KeyConfig\Dao as KeyConfigDao;
 use Pimcore\Model\DataObject\Classificationstore\KeyGroupRelation\Listing;
 use function count;
 
 /**
  * @internal
  */
-final class KeyGroupRelationRepository implements KeyGroupRelationRepositoryInterface
+final readonly class KeyGroupRelationRepository implements KeyGroupRelationRepositoryInterface
 {
     public function __construct(
-        private GroupConfigRepositoryInterface $groupConfigRepository
+        private GroupConfigRepositoryInterface $groupConfigRepository,
+        private SearchHelperServiceInterface $searchHelperService
     ) {
     }
 
@@ -36,7 +40,8 @@ public function __construct(
     public function getPaginatedKeyGroupRelationByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $groupIds = null
+        ?array $groupIds = null,
+        ?string $searchTerm = null
     ): array {
 
         $groupIds = array_map(
@@ -50,7 +55,11 @@ public function getPaginatedKeyGroupRelationByStore(
         $listing->setOrderKey('sorter');
         $this->applyGroupIdsFilter($listing, $groupIds);
 
-        return $listing->load();
+        if ($searchTerm !== null) {
+            $this->applySearchTermFilter($listing, $searchTerm);
+        }
+
+        return $listing->getList();
     }
 
     public function getCountByStoreId(int $storeId, ?array $groupIds = null): int
@@ -66,6 +75,22 @@ public function getCountByStoreId(int $storeId, ?array $groupIds = null): int
         return $listing->count();
     }
 
+    private function applySearchTermFilter(Listing $list, string $searchTerm): void
+    {
+        $searchTerms = $this->searchHelperService->getTranslatedSearchFilterTerms($searchTerm);
+        $searchFilterConditions = [];
+
+        foreach ($searchTerms as $term) {
+            $searchFilterConditions[] =
+                KeyConfigDao::TABLE_NAME_KEYS.'.name LIKE '.$list->quote('%'.$term.'%')
+                .' OR '.GroupConfigDao::TABLE_NAME_GROUPS.'.name LIKE '.$list->quote('%'.$term.'%')
+                .' OR '.KeyConfigDao::TABLE_NAME_KEYS.'.description LIKE '.$list->quote('%'.$term.'%');
+        }
+        $list->setResolveGroupName(true);
+
+        $list->addConditionParam(implode(' OR ', $searchFilterConditions));
+    }
+
     private function applyGroupIdsFilter(Listing $list, array $groupIds): void
     {
         $placeholders = implode(',', array_fill(0, count($groupIds), '?'));

src/ClassificationStore/Repository/KeyGroupRelationRepositoryInterface.php

@@ -30,7 +30,8 @@ interface KeyGroupRelationRepositoryInterface
     public function getPaginatedKeyGroupRelationByStore(
         int $storeId,
         CollectionParametersInterface $collectionParameters,
-        ?array $groupIds = null
+        ?array $groupIds = null,
+        ?string $searchTerm = null
     ): array;
 
     public function getCountByStoreId(int $storeId, ?array $groupIds = null): int;

src/ClassificationStore/Service/CollectionService.php

@@ -56,7 +56,8 @@ public function getCollections(ListClassificationStoreParameter $parameter): Col
         $collections = $this->collectionConfigRepository->getPaginatedCollectionsByStore(
             $parameter->getStoreId(),
             $parameter,
-            $allowedCollectionIds
+            $allowedCollectionIds,
+            $parameter->getSearchTerm()
         );
 
         $hydratedCollections = [];

src/ClassificationStore/Service/GroupService.php

@@ -54,7 +54,8 @@ public function getGroups(ListClassificationStoreParameter $parameter): Collecti
         $groups = $this->groupConfigRepository->getPaginatedGroupsByStore(
             $parameter->getStoreId(),
             $parameter,
-            $allowedGroupIds
+            $allowedGroupIds,
+            $parameter->getSearchTerm()
         );
 
         $hydratedGroups = [];

src/ClassificationStore/Service/KeyGroupRelationService.php

@@ -54,7 +54,8 @@ public function getKeyGroupRelations(ListClassificationStoreParameter $parameter
         $keyGroupRelations = $this->keyGroupRelationRepository->getPaginatedKeyGroupRelationByStore(
             $parameter->getStoreId(),
             $parameter,
-            $allowedGroupIds
+            $allowedGroupIds,
+            $parameter->getSearchTerm()
         );
 
         foreach ($keyGroupRelations as $keyGroupRelation) {

src/ClassificationStore/Service/SearchHelperService.php

@@ -0,0 +1,70 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service;
+
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\UserNotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\Security\Service\SecurityServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\Translation\Repository\TranslationRepositoryInterface;
+use Pimcore\Model\DataObject\Classificationstore\CollectionConfig\Listing as CollectionConfigListing;
+use Pimcore\Model\DataObject\Classificationstore\GroupConfig\Listing as GroupConfigListing;
+use Pimcore\Model\Translation;
+
+/**
+ * @internal
+ */
+final readonly class SearchHelperService implements SearchHelperServiceInterface
+{
+    public function __construct(
+        private TranslationRepositoryInterface $translationRepository,
+        private SecurityServiceInterface $securityService
+    ) {
+    }
+
+    public function applySearchTermFilter(GroupConfigListing|CollectionConfigListing $list, string $searchTerm): void
+    {
+        $searchTerms = $this->getTranslatedSearchFilterTerms($searchTerm);
+
+        $conditions = [];
+        $preparedSearchTerms = [];
+        foreach ($searchTerms as $term) {
+            $conditions[] = 'name LIKE ? OR description LIKE ?';
+            $preparedSearchTerms[] = '%' . $term . '%';
+            $preparedSearchTerms[] = '%' . $term . '%';
+        }
+
+        $list->addConditionParam('(' . implode(' OR ', $conditions) . ')', $preparedSearchTerms);
+    }
+
+    public function getTranslatedSearchFilterTerms(string $searchTerm): array
+    {
+        try {
+            $user = $this->securityService->getCurrentUser();
+
+            $translatedSearchKeys = $this->translationRepository->getTranslationKeysWithTextFilter(
+                $searchTerm,
+                $user->getLanguage(),
+                Translation::DOMAIN_ADMIN
+            );
+
+            $searchTerms = array_merge([$searchTerm], $translatedSearchKeys);
+        } catch (UserNotFoundException) {
+            $searchTerms = [$searchTerm];
+        }
+
+        return $searchTerms;
+    }
+}

src/ClassificationStore/Service/SearchHelperServiceInterface.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Service;
+
+use Pimcore\Model\DataObject\Classificationstore\CollectionConfig\Listing as CollectionConfigListing;
+use Pimcore\Model\DataObject\Classificationstore\GroupConfig\Listing as GroupConfigListing;
+
+/**
+ * @internal
+ */
+interface SearchHelperServiceInterface
+{
+    public function applySearchTermFilter(GroupConfigListing|CollectionConfigListing $list, string $searchTerm): void;
+
+    public function getTranslatedSearchFilterTerms(string $searchTerm): array;
+}