Split parameters (#40)

* Split parameters * Apply php-cs-fixer changes --------- Co-authored-by: mattamon <mattamon@users.noreply.github.com>
pimcore · Apr 23, 2024 · f6bb681 · f6bb681
1 parent 3affb80
commit f6bb681
Show file tree

Hide file tree

Showing 17 changed files with 130 additions and 53 deletions.
diff --git a/src/Controller/Api/Assets/CollectionController.php b/src/Controller/Api/Assets/CollectionController.php
@@ -37,7 +37,7 @@
 use Pimcore\Bundle\StudioApiBundle\Controller\Api\AbstractApiController;
 use Pimcore\Bundle\StudioApiBundle\Controller\Trait\PaginatedResponseTrait;
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\Parameters;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ElementParameters;
 use Pimcore\Bundle\StudioApiBundle\Service\AssetSearchServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterServiceInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -90,7 +90,7 @@ public function __construct(
     #[MethodNotAllowedResponse]
     #[UnsupportedMediaTypeResponse]
     #[UnprocessableContentResponse]
-    public function getAssets(#[MapQueryString] Parameters $parameters): JsonResponse
+    public function getAssets(#[MapQueryString] ElementParameters $parameters): JsonResponse
     {
         $assetQuery = $this->filterService->applyFilters(
             $parameters,

diff --git a/src/Filter/DataObject/ClassNameFilter.php b/src/Filter/DataObject/ClassNameFilter.php
@@ -18,8 +18,8 @@
 
 use Exception;
 use Pimcore\Bundle\StudioApiBundle\Filter\FilterInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\DataObjectParametersInterface;
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\DataObjectQuery;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
@@ -31,7 +31,7 @@ final class ClassNameFilter implements FilterInterface
     /**
      * @throws Exception
      */
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
         if(
             !$parameters instanceof DataObjectParametersInterface ||

diff --git a/src/Filter/ExcludeFolderFilter.php b/src/Filter/ExcludeFolderFilter.php
@@ -16,16 +16,21 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ElementParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class ExcludeFolderFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
+        if (!$parameters instanceof ElementParametersInterface) {
+            return $query;
+        }
+
         $excludeFolders = $parameters->getExcludeFolders();
         if(!$excludeFolders) {
             return $query;

diff --git a/src/Filter/FilterInterface.php b/src/Filter/FilterInterface.php
@@ -16,13 +16,13 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 interface FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface;
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface;
 }
diff --git a/src/Filter/IdSearchFilter.php b/src/Filter/IdSearchFilter.php
@@ -16,16 +16,21 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ElementParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class IdSearchFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
+        if (!$parameters instanceof ElementParametersInterface) {
+            return $query;
+        }
+
         $idSearchTerm = $parameters->getIdSearchTerm();
 
         if(!$idSearchTerm) {

diff --git a/src/Filter/PageFilter.php b/src/Filter/PageFilter.php
@@ -16,15 +16,15 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class PageFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
         return $query->setPage($parameters->getPage());
     }

diff --git a/src/Filter/PageSizeFilter.php b/src/Filter/PageSizeFilter.php
@@ -16,15 +16,15 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class PageSizeFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
         return $query->setPageSize($parameters->getPageSize());
     }

diff --git a/src/Filter/ParentIdFilter.php b/src/Filter/ParentIdFilter.php
@@ -16,16 +16,21 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ElementParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class ParentIdFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
+        if (!$parameters instanceof ElementParametersInterface) {
+            return $query;
+        }
+
         $parentId = $parameters->getParentId();
 
         if(!$parentId) {

diff --git a/src/Filter/PathFilter.php b/src/Filter/PathFilter.php
@@ -16,16 +16,21 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ElementParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
  * @internal
  */
 final class PathFilter implements FilterInterface
 {
-    public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface
+    public function apply(CollectionParametersInterface $parameters, QueryInterface $query): QueryInterface
     {
+        if (!$parameters instanceof ElementParametersInterface) {
+            return $query;
+        }
+
         $path = $parameters->getPath();
         $includeParent = $parameters->getPathIncludeParent();
         $includeDescendants = $parameters->getPathIncludeDescendants();

diff --git a/src/Request/Query/Filter/CollectionParameters.php b/src/Request/Query/Filter/CollectionParameters.php
@@ -0,0 +1,54 @@
+<?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\Request\Query\Filter;
+
+use Pimcore\ValueObject\Integer\PositiveInteger;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Constraints\Positive;
+
+/**
+ * @internal
+ */
+readonly class CollectionParameters implements CollectionParametersInterface
+{
+    public function __construct(
+        #[NotBlank]
+        #[Positive]
+        private int $page = 1,
+        #[NotBlank]
+        #[Positive]
+        private int $pageSize = 10,
+    ) {
+        $this->validate();
+    }
+
+    public function getPage(): int
+    {
+        return $this->page;
+    }
+
+    public function getPageSize(): int
+    {
+        return $this->pageSize;
+    }
+
+    private function validate(): void
+    {
+        new PositiveInteger($this->page);
+        new PositiveInteger($this->pageSize);
+    }
+}
diff --git a/src/Request/Query/Filter/CollectionParametersInterface.php b/src/Request/Query/Filter/CollectionParametersInterface.php
@@ -0,0 +1,27 @@
+<?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\Request\Query\Filter;
+
+/**
+ * @internal
+ */
+interface CollectionParametersInterface
+{
+    public function getPage(): int;
+
+    public function getPageSize(): int;
+}
diff --git a/src/Request/Query/Filter/DataObjectParameters.php b/src/Request/Query/Filter/DataObjectParameters.php
@@ -19,7 +19,7 @@
 /**
  * @internal
  */
-final readonly class DataObjectParameters extends Parameters implements DataObjectParametersInterface
+final readonly class DataObjectParameters extends ElementParameters implements DataObjectParametersInterface
 {
     public function __construct(
         int $page = 1,

diff --git a/src/Request/Query/Filter/DataObjectParametersInterface.php b/src/Request/Query/Filter/DataObjectParametersInterface.php
@@ -19,7 +19,7 @@
 /**
  * @internal
  */
-interface DataObjectParametersInterface extends ParametersInterface
+interface DataObjectParametersInterface extends ElementParametersInterface
 {
     public function getClassName(): ?string;
 }
diff --git a/src/Request/Query/Filter/Parameters.php → ...equest/Query/Filter/ElementParameters.php b/src/Request/Query/Filter/Parameters.php → ...equest/Query/Filter/ElementParameters.php
@@ -16,40 +16,22 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Request\Query\Filter;
 
-use Pimcore\ValueObject\Integer\PositiveInteger;
-use Symfony\Component\Validator\Constraints\NotBlank;
-use Symfony\Component\Validator\Constraints\Positive;
-
 /**
  * @internal
  */
-readonly class Parameters implements ParametersInterface
+readonly class ElementParameters extends CollectionParameters implements ElementParametersInterface
 {
     public function __construct(
-        #[NotBlank]
-        #[Positive]
-        private int $page = 1,
-        #[NotBlank]
-        #[Positive]
-        private int $pageSize = 10,
+        int $page = 1,
+        int $pageSize = 10,
         private ?int $parentId = null,
         private ?string $idSearchTerm = null,
         private ?string $excludeFolders = null,
         private ?string $path = null,
         private ?string $pathIncludeParent = null,
         private ?string $pathIncludeDescendants = null
     ) {
-        $this->validate();
-    }
-
-    public function getPage(): int
-    {
-        return $this->page;
-    }
-
-    public function getPageSize(): int
-    {
-        return $this->pageSize;
+        parent::__construct($page, $pageSize);
     }
 
     public function getParentId(): ?int
@@ -81,10 +63,4 @@ public function getPathIncludeDescendants(): ?bool
     {
         return $this->pathIncludeDescendants === 'true'; // TODO: symfony 7.1 will support bool type
     }
-
-    private function validate(): void
-    {
-        new PositiveInteger($this->page);
-        new PositiveInteger($this->pageSize);
-    }
 }
diff --git a/...uest/Query/Filter/ParametersInterface.php → ...ery/Filter/ElementParametersInterface.php b/...uest/Query/Filter/ParametersInterface.php → ...ery/Filter/ElementParametersInterface.php
@@ -19,7 +19,7 @@
 /**
  * @internal
  */
-interface ParametersInterface
+interface ElementParametersInterface
 {
     public function getPage(): int;
 

diff --git a/src/Service/Filter/FilterService.php b/src/Service/Filter/FilterService.php
@@ -19,7 +19,7 @@
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidFilterTypeException;
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
 use Pimcore\Bundle\StudioApiBundle\Factory\QueryFactoryInterface;
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\Parameters;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
@@ -37,7 +37,7 @@ public function __construct(
      * @throws InvalidQueryTypeException
      * @throws InvalidFilterTypeException
      */
-    public function applyFilters(Parameters $parameters, string $type): QueryInterface
+    public function applyFilters(CollectionParametersInterface $parameters, string $type): QueryInterface
     {
         $query = $this->queryFactory->create($type);
         // apply default filters

diff --git a/src/Service/Filter/FilterServiceInterface.php b/src/Service/Filter/FilterServiceInterface.php
@@ -17,7 +17,7 @@
 namespace Pimcore\Bundle\StudioApiBundle\Service\Filter;
 
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
-use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\Parameters;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\CollectionParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
 /**
@@ -34,5 +34,5 @@ interface FilterServiceInterface
     /**
      * @throws InvalidQueryTypeException
      */
-    public function applyFilters(Parameters $parameters, string $type): QueryInterface;
+    public function applyFilters(CollectionParametersInterface $parameters, string $type): QueryInterface;
 }