Add compiler pass for filterinterface

pimcore · Apr 15, 2024 · 9ed2136 · 9ed2136
1 parent 0940db0
commit 9ed2136
Show file tree

Hide file tree

Showing 14 changed files with 137 additions and 22 deletions.
diff --git a/config/filters.yaml b/config/filters.yaml
@@ -4,10 +4,13 @@ services:
     autoconfigure: true
     public: false
 
-
+  #Filter
   Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterLoaderInterface:
     class: Pimcore\Bundle\StudioApiBundle\Service\Filter\Loader\TaggedIteratorAdapter
 
+  Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterServiceInterface:
+    class: Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterService
+
   Pimcore\Bundle\StudioApiBundle\Filter\PageFilter:
     tags: [ 'pimcore.studio_api.collection.filter' ]
 

diff --git a/config/services.yaml b/config/services.yaml
@@ -117,11 +117,6 @@ services:
                 Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\SearchResultItem\Unknown: '@Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\Hydrator\Asset\UnknownHydratorInterface'
                 Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\SearchResultItem\Video: '@Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\Hydrator\Asset\VideoHydratorInterface'
 
-
-    #Filter
-    Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterServiceInterface:
-        class: Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterService
-
     #Factory
     Pimcore\Bundle\StudioApiBundle\Factory\QueryFactoryInterface:
         class: Pimcore\Bundle\StudioApiBundle\Factory\QueryFactory

diff --git a/src/DependencyInjection/CompilerPass/FilterPass.php b/src/DependencyInjection/CompilerPass/FilterPass.php
@@ -0,0 +1,48 @@
+<?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\StudioApiBundle\DependencyInjection\CompilerPass;
+
+use Pimcore\Bundle\StudioApiBundle\Exception\MustImplementInterfaceException;
+use Pimcore\Bundle\StudioApiBundle\Filter\FilterInterface;
+use Pimcore\Bundle\StudioApiBundle\Service\Filter\Loader\TaggedIteratorAdapter;
+use Pimcore\Bundle\StudioApiBundle\Util\Traits\MustImplementInterfaceTrait;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @internal
+ */
+final class FilterPass implements CompilerPassInterface
+{
+    use MustImplementInterfaceTrait;
+
+    /**
+     * @throws MustImplementInterfaceException
+     */
+    public function process(ContainerBuilder $container): void
+    {
+        $taggedServices = array_keys(
+            $container->findTaggedServiceIds(
+                TaggedIteratorAdapter::FILTER_TAG
+            )
+        );
+
+        foreach ($taggedServices as $environmentType) {
+            $this->checkInterface($environmentType, FilterInterface::class);
+        }
+    }
+}
diff --git a/src/Exception/MustImplementInterfaceException.php b/src/Exception/MustImplementInterfaceException.php
@@ -0,0 +1,26 @@
+<?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\StudioApiBundle\Exception;
+
+use Exception;
+
+/**
+ * @internal
+ */
+final class MustImplementInterfaceException extends Exception
+{
+}
diff --git a/src/Filter/ExcludeFolderFilter.php b/src/Filter/ExcludeFolderFilter.php
@@ -17,19 +17,17 @@
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
 use Pimcore\Bundle\StudioApiBundle\Dto\Collection;
-use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\AssetQuery;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 final class ExcludeFolderFilter implements FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface
     {
         $excludeFolders = $collection->getExcludeFolders();
         if(!$excludeFolders) {
             return $query;
         }
 
-        /** @var AssetQuery $query */
         return $query->excludeFolders();
     }
 }
diff --git a/src/Filter/FilterInterface.php b/src/Filter/FilterInterface.php
@@ -21,5 +21,5 @@
 
 interface FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed;
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface;
 }
diff --git a/src/Filter/IdSearchFilter.php b/src/Filter/IdSearchFilter.php
@@ -17,20 +17,18 @@
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
 use Pimcore\Bundle\StudioApiBundle\Dto\Collection;
-use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\AssetQuery;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 final class IdSearchFilter implements FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface
     {
         $idSearchTerm = $collection->getIdSearchTerm();
 
         if(!$idSearchTerm) {
             return $query;
         }
 
-        /** @var AssetQuery $query */
         return $query->setSearchTerm($idSearchTerm);
     }
 }
diff --git a/src/Filter/PageFilter.php b/src/Filter/PageFilter.php
@@ -21,7 +21,7 @@
 
 final class PageFilter implements FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface
     {
         return $query->setPage($collection->getPage());
     }

diff --git a/src/Filter/PageSizeFilter.php b/src/Filter/PageSizeFilter.php
@@ -21,7 +21,7 @@
 
 final class PageSizeFilter implements FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface
     {
         return $query->setPageSize($collection->getPageSize());
     }

diff --git a/src/Filter/ParentIdFilter.php b/src/Filter/ParentIdFilter.php
@@ -17,19 +17,18 @@
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
 use Pimcore\Bundle\StudioApiBundle\Dto\Collection;
-use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\AssetQuery;
+use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 final class ParentIdFilter implements FilterInterface
 {
-    public function apply(Collection $collection, mixed $query): mixed
+    public function apply(Collection $collection, mixed $query): QueryInterface
     {
         $parentId = $collection->getParentId();
 
         if(!$parentId) {
             return $query;
         }
 
-        /** @var AssetQuery $query */
         return $query->filterParentId($parentId);
     }
 }
diff --git a/src/Filter/PathFilter.php b/src/Filter/PathFilter.php
@@ -17,12 +17,11 @@
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
 use Pimcore\Bundle\StudioApiBundle\Dto\Collection;
-use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\AssetQuery;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 final class PathFilter implements FilterInterface
 {
-    public function apply(Collection $collection, QueryInterface $query): mixed
+    public function apply(Collection $collection, QueryInterface $query): QueryInterface
     {
         $path = $collection->getPath();
         $includeParent = $collection->getPathIncludeParent();
@@ -32,7 +31,6 @@ public function apply(Collection $collection, QueryInterface $query): mixed
             return $query;
         }
 
-        /** @var AssetQuery $query */
         return $query->filterPath($path, $includeDescendants, $includeParent);
     }
 }
diff --git a/src/PimcoreStudioApiBundle.php b/src/PimcoreStudioApiBundle.php
@@ -16,8 +16,10 @@
 
 namespace Pimcore\Bundle\StudioApiBundle;
 
+use Pimcore\Bundle\StudioApiBundle\DependencyInjection\CompilerPass\FilterPass;
 use Pimcore\Extension\Bundle\AbstractPimcoreBundle;
 use Pimcore\Extension\Bundle\Installer\InstallerInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class PimcoreStudioApiBundle extends AbstractPimcoreBundle
 {
@@ -53,4 +55,9 @@ public function getInstaller(): ?InstallerInterface
         /** @var InstallerInterface|null */
         return $this->container->get(Installer::class);
     }
+
+    public function build(ContainerBuilder $container): void
+    {
+        $container->addCompilerPass(new FilterPass());
+    }
 }
diff --git a/src/Service/Filter/Loader/TaggedIteratorAdapter.php b/src/Service/Filter/Loader/TaggedIteratorAdapter.php
@@ -24,8 +24,10 @@
  */
 final class TaggedIteratorAdapter implements FilterLoaderInterface
 {
+    public const FILTER_TAG = 'pimcore.studio_api.collection.filter';
+
     public function __construct(
-        #[TaggedIterator('pimcore.studio_api.collection.filter')]
+        #[TaggedIterator(self::FILTER_TAG)]
         private readonly iterable $taggedServices
     ) {
     }

diff --git a/src/Util/Traits/MustImplementInterfaceTrait.php b/src/Util/Traits/MustImplementInterfaceTrait.php
@@ -0,0 +1,41 @@
+<?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\StudioApiBundle\Util\Traits;
+
+use Pimcore\Bundle\StudioApiBundle\Exception\MustImplementInterfaceException;
+
+/**
+ * @internal
+ */
+trait MustImplementInterfaceTrait
+{
+    /**
+     * @throws MustImplementInterfaceException
+     */
+    private function checkInterface(string $class, string $interface): void
+    {
+        $classInterfaces = class_implements($class, false);
+        if (
+            $classInterfaces === false ||
+            !in_array($interface, $classInterfaces, true)
+        ) {
+            throw new MustImplementInterfaceException(
+                sprintf('%s must implement %s', $class, $interface)
+            );
+        }
+    }
+}