Switch to path parameters for element (#83)

* Change to path parameters * Consistency checks * Remove positive integer * Rename request to MappedParameter * Remove unused class
pimcore · Jun 3, 2024 · 0384279 · 0384279
1 parent b4f673e
commit 0384279
Show file tree

Hide file tree

Showing 20 changed files with 180 additions and 189 deletions.
diff --git a/...dency/Controller/CollectionController.php → ...ntroller/Element/CollectionController.php b/...dency/Controller/CollectionController.php → ...ntroller/Element/CollectionController.php
@@ -14,22 +14,23 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Dependency\Controller;
+namespace Pimcore\Bundle\StudioBackendBundle\Dependency\Controller\Element;
 
 use OpenApi\Attributes\Get;
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Attributes\Parameters\Query\DependencyModeParameter;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Attributes\Response\Property\DependencyCollection;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Request\DependencyParameters;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Service\DependencyServiceInterface;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\ElementTypeParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\IdParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\ElementTypeParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\PageParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\PageSizeParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\Content\CollectionJson;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Request\ElementParameters;
 use Pimcore\Bundle\StudioBackendBundle\Security\Service\SecurityServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Traits\PaginatedResponseTrait;
@@ -48,28 +49,28 @@ final class CollectionController extends AbstractApiController
     public function __construct(
         SerializerInterface $serializer,
         private readonly SecurityServiceInterface $securityService,
-        private readonly DependencyServiceInterface $hydratorService,
+        private readonly DependencyServiceInterface $dependencyService,
     ) {
         parent::__construct($serializer);
     }
 
-    #[Route('/dependencies', name: 'pimcore_studio_api_dependencies', methods: ['GET'])]
+    #[Route('/dependencies/{elementType}/{id}', name: 'pimcore_studio_api_dependencies', methods: ['GET'])]
     //#[IsGranted('STUDIO_API')]
     #[Get(
-        path: self::API_PATH . '/dependencies',
+        path: self::API_PATH . '/dependencies/{elementType}/{id}',
         operationId: 'getDependencies',
-        description: 'Get paginated dependencies. 
-        Pass dependency mode to get either all elements that depend on the provided element 
+        description: 'Get paginated dependencies.
+        Pass dependency mode to get either all elements that depend on the provided element
         or all dependencies for the provided element.',
         summary: 'Get all dependencies for provided element.',
         security: self::SECURITY_SCHEME,
         tags: [Tags::Dependencies->name]
     )]
+    #[ElementTypeParameter]
+    #[IdParameter('element')]
     #[PageParameter]
     #[PageSizeParameter]
-    #[IdParameter('ID of the element', 'element')]
     #[DependencyModeParameter]
-    #[ElementTypeParameter]
     #[SuccessResponse(
         description: 'Paginated dependencies with total count as header param',
         content: new CollectionJson(new DependencyCollection())
@@ -78,9 +79,14 @@ public function __construct(
         HttpResponseCodes::UNAUTHORIZED,
         HttpResponseCodes::NOT_FOUND,
     ])]
-    public function getDependencies(#[MapQueryString] DependencyParameters $parameters): JsonResponse
+    public function getDependencies(
+        string $elementType,
+        int $id,
+        #[MapQueryString] DependencyParameters $parameters
+    ): JsonResponse
     {
-        $collection = $this->hydratorService->getDependencies(
+        $collection = $this->dependencyService->getDependencies(
+            new ElementParameters($elementType, $id),
             $parameters,
             $this->securityService->getCurrentUser()
         );

diff --git a/src/Dependency/Request/DependencyParameters.php b/src/Dependency/Request/DependencyParameters.php
@@ -30,9 +30,7 @@
     public function __construct(
         int $page,
         int $pageSize,
-        string $dependencyMode,
-        private int $elementId,
-        private string $elementType
+        string $dependencyMode
     ) {
         $this->mode = $this->getDependencyMode($dependencyMode);
         parent::__construct($page, $pageSize);
@@ -43,20 +41,6 @@ public function getMode(): DependencyMode
         return $this->mode;
     }
 
-    public function getElementId(): int
-    {
-        return $this->elementId;
-    }
-
-    public function getElementType(): string
-    {
-        if ($this->elementType === ElementTypes::TYPE_DATA_OBJECT) {
-            return ElementTypes::TYPE_OBJECT;
-        }
-
-        return $this->elementType;
-    }
-
     private function getDependencyMode(string $mode): DependencyMode {
         $dependencyMode = DependencyMode::tryFrom($mode);
 

diff --git a/src/Dependency/Service/DependencyService.php b/src/Dependency/Service/DependencyService.php
@@ -21,6 +21,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Repository\DependencyRepositoryInterface;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Request\DependencyParameters;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Response\Collection;
+use Pimcore\Bundle\StudioBackendBundle\Request\ElementParameters;
 use Pimcore\Bundle\StudioBackendBundle\Util\Traits\ElementProviderTrait;
 use Pimcore\Model\UserInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -36,13 +37,14 @@ public function __construct(
     ) {
     }
     public function getDependencies(
+        ElementParameters $elementParameters,
         DependencyParameters $parameters,
         UserInterface $user
     ): Collection
     {
         return match ($parameters->getMode()) {
-            DependencyMode::REQUIRES => $this->getRequiredDependencies($parameters),
-            DependencyMode::REQUIRED_BY => $this->getRequiredByDependencies($parameters),
+            DependencyMode::REQUIRES => $this->getRequiredDependencies($elementParameters, $parameters),
+            DependencyMode::REQUIRED_BY => $this->getRequiredByDependencies($elementParameters, $parameters),
         };
     }
 
@@ -65,12 +67,13 @@ private function getDependencyCollection(array $dependencies): array
     }
 
     private function getRequiredDependencies(
+        ElementParameters $elementParameters,
         DependencyParameters $parameters
     ): Collection {
 
         $dependencies = $this->dependencyRepository->listRequiresDependencies(
-            $parameters->getElementType(),
-            $parameters->getElementId()
+            $elementParameters->getType(),
+            $elementParameters->getId()
         );
 
         $dependencies = $this->getDependencyCollection($dependencies);
@@ -80,18 +83,19 @@ private function getRequiredDependencies(
             $parameters->getPage(),
             $parameters->getPageSize(),
             $this->dependencyRepository->listRequiresDependenciesTotalCount(
-                $parameters->getElementType(),
-                $parameters->getElementId()
+                $elementParameters->getType(),
+                $elementParameters->getId()
             )
         );
     }
 
     private function getRequiredByDependencies(
+        ElementParameters $elementParameters,
         DependencyParameters $parameters
     ): Collection {
         $dependencies = $this->dependencyRepository->listRequiredByDependencies(
-            $parameters->getElementType(),
-            $parameters->getElementId()
+            $elementParameters->getType(),
+            $elementParameters->getId()
         );
 
         $dependencies = $this->getDependencyCollection($dependencies);
@@ -101,8 +105,8 @@ private function getRequiredByDependencies(
             $parameters->getPage(),
             $parameters->getPageSize(),
             $this->dependencyRepository->listRequiredByDependenciesTotalCount(
-                $parameters->getElementType(),
-                $parameters->getElementId()
+                $elementParameters->getType(),
+                $elementParameters->getId()
             )
         );
     }

diff --git a/src/Dependency/Service/DependencyServiceInterface.php b/src/Dependency/Service/DependencyServiceInterface.php
@@ -18,11 +18,13 @@
 
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Request\DependencyParameters;
 use Pimcore\Bundle\StudioBackendBundle\Dependency\Response\Collection;
+use Pimcore\Bundle\StudioBackendBundle\Request\ElementParameters;
 use Pimcore\Model\UserInterface;
 
 interface DependencyServiceInterface
 {
     public function getDependencies(
+        ElementParameters $elementParameters,
         DependencyParameters $parameters,
         UserInterface $user
     ): Collection;

diff --git a/src/Property/Controller/CollectionController.php b/src/Property/Controller/CollectionController.php
@@ -24,7 +24,7 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\PropertiesParameters;
+use Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter\PropertiesParameters;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\PredefinedProperty;
 use Pimcore\Bundle\StudioBackendBundle\Property\Service\PropertyServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;

diff --git a/...Property/Request/PropertiesParameters.php → .../MappedParameter/PropertiesParameters.php b/...Property/Request/PropertiesParameters.php → .../MappedParameter/PropertiesParameters.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Property\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter;
 
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\ElementTypes;
 

diff --git a/src/Property/Repository/PropertyRepository.php b/src/Property/Repository/PropertyRepository.php
@@ -19,7 +19,7 @@
 use Pimcore\Bundle\StaticResolverBundle\Models\Predefined\PredefinedResolverInterface;
 use Pimcore\Bundle\StudioBackendBundle\Exception\NotWriteableException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\PropertyNotFoundException;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\PropertiesParameters;
+use Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter\PropertiesParameters;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\UpdatePredefinedProperty;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\ElementTypes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Traits\ElementProviderTrait;

diff --git a/src/Property/Repository/PropertyRepositoryInterface.php b/src/Property/Repository/PropertyRepositoryInterface.php
@@ -18,7 +18,7 @@
 
 use Pimcore\Bundle\StudioBackendBundle\Exception\NotWriteableException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\PropertyNotFoundException;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\PropertiesParameters;
+use Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter\PropertiesParameters;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\UpdatePredefinedProperty;
 use Pimcore\Model\Element\ElementInterface;
 use Pimcore\Model\Property\Predefined;

diff --git a/src/Property/Request/UpdateElementProperties.php b/src/Property/Request/UpdateElementProperties.php
diff --git a/src/Property/Service/PropertyService.php b/src/Property/Service/PropertyService.php
@@ -23,8 +23,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Property\Event\PredefinedPropertyEvent;
 use Pimcore\Bundle\StudioBackendBundle\Property\Hydrator\PropertyHydratorInterface;
 use Pimcore\Bundle\StudioBackendBundle\Property\Repository\PropertyRepositoryInterface;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\PropertiesParameters;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\UpdateElementProperties;
+use Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter\PropertiesParameters;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\ElementProperty;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\PredefinedProperty;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\UpdatePredefinedProperty;

diff --git a/src/Property/Service/PropertyServiceInterface.php b/src/Property/Service/PropertyServiceInterface.php
@@ -19,7 +19,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\NotWriteableException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\PropertyNotFoundException;
-use Pimcore\Bundle\StudioBackendBundle\Property\Request\PropertiesParameters;
+use Pimcore\Bundle\StudioBackendBundle\Property\MappedParameter\PropertiesParameters;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\ElementProperty;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\PredefinedProperty;
 use Pimcore\Bundle\StudioBackendBundle\Property\Schema\UpdatePredefinedProperty;

diff --git a/src/Request/ElementParameters.php b/src/Request/ElementParameters.php
@@ -0,0 +1,61 @@
+<?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\Request;
+
+use Pimcore\Bundle\StudioBackendBundle\Exception\InvalidElementTypeException;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constants\ElementTypes;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Constraints\Positive;
+
+/**
+ * @internal
+ */
+final readonly class ElementParameters
+{
+    public function __construct(
+        #[NotBlank]
+        private string $type,
+        #[NotBlank]
+        #[Positive]
+        private int    $id,
+    ) {
+        $this->validate();
+    }
+
+    public function getType(): string
+    {
+        if ($this->type === ElementTypes::TYPE_DATA_OBJECT) {
+            return ElementTypes::TYPE_OBJECT;
+        }
+        return $this->type;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @throws InvalidElementTypeException
+     */
+    private function validate(): void
+    {
+        if (!in_array($this->type, ElementTypes::ALLOWED_TYPES)) {
+            throw new InvalidElementTypeException($this->type);
+        }
+    }
+}