[Data Object Editor] Quantity value endpoints tag handling (#619)

* add quantity value changes * Apply php-cs-fixer changes * remove unused request class --------- Co-authored-by: lukmzig <lukmzig@users.noreply.github.com>
pimcore · Dec 4, 2024 · d15a9d8 · d15a9d8
1 parent d8c8f9d
commit d15a9d8
Show file tree

Hide file tree

Showing 23 changed files with 214 additions and 114 deletions.
diff --git a/config/class.yaml b/config/class.yaml
@@ -20,12 +20,6 @@ services:
   Pimcore\Bundle\StudioBackendBundle\Class\Service\ObjectBrick\LayoutDefinitionServiceInterface:
     class: Pimcore\Bundle\StudioBackendBundle\Class\Service\ObjectBrick\LayoutDefinitionService
 
-  Pimcore\Bundle\StudioBackendBundle\Class\Repository\QuantityValueRepositoryInterface:
-    class: Pimcore\Bundle\StudioBackendBundle\Class\Repository\QuantityValueRepository
-
-  Pimcore\Bundle\StudioBackendBundle\Class\Service\QuantityValueServiceInterface:
-    class: Pimcore\Bundle\StudioBackendBundle\Class\Service\QuantityValueService
-
   #
   # Hydrators
   #

diff --git a/config/units.yaml b/config/units.yaml
@@ -0,0 +1,26 @@
+services:
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: false
+
+  # controllers are imported separately to make sure they're public
+  # and have a tag that allows actions to type-hint services
+  Pimcore\Bundle\StudioBackendBundle\Unit\Controller\:
+    resource: '../src/Unit/Controller'
+    public: true
+    tags: [ 'controller.service_arguments' ]
+
+  #
+  # Services
+  #
+
+  Pimcore\Bundle\StudioBackendBundle\Unit\Service\QuantityValueServiceInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Unit\Service\QuantityValueService
+
+  #
+  # Repositories
+  #
+
+  Pimcore\Bundle\StudioBackendBundle\Unit\Repository\QuantityValueRepositoryInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Unit\Repository\QuantityValueRepository
diff --git a/src/OpenApi/Attribute/Parameter/Query/TextFieldParameter.php b/src/OpenApi/Attribute/Parameter/Query/TextFieldParameter.php
@@ -20,7 +20,7 @@
 use OpenApi\Attributes\QueryParameter;
 use OpenApi\Attributes\Schema;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class TextFieldParameter extends QueryParameter
 {
     public function __construct(string $name, string $description, bool $required = false, string $example = null)

diff --git a/src/OpenApi/Config/Tags.php b/src/OpenApi/Config/Tags.php
@@ -113,6 +113,10 @@
     name: Tags::Translation->value,
     description: 'tag_translation_description'
 )]
+#[Tag(
+    name: Tags::Units->value,
+    description: 'tag_units_description'
+)]
 #[Tag(
     name: Tags::User->value,
     description: 'tag_user_description'
@@ -150,6 +154,7 @@ enum Tags: string
     case Tags = 'Tags';
     case TagsForElement = 'Tags for Element';
     case Translation = 'Translation';
+    case Units = 'Units';
     case User = 'User Management';
     case Versions = 'Versions';
     case Workflows = 'Workflows';

diff --git a/.../Attribute/Request/ConvertRequestBody.php → ...ribute/Parameter/Query/ValueParameter.php b/.../Attribute/Request/ConvertRequestBody.php → ...ribute/Parameter/Query/ValueParameter.php
@@ -14,21 +14,29 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Parameter\Query;
 
 use Attribute;
-use OpenApi\Attributes\JsonContent;
-use OpenApi\Attributes\RequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\ConvertParameters;
+use OpenApi\Attributes\QueryParameter;
+use OpenApi\Attributes\Schema;
 
 #[Attribute(Attribute::TARGET_METHOD)]
-final class ConvertRequestBody extends RequestBody
+final class ValueParameter extends QueryParameter
 {
-    public function __construct(string $ref = ConvertParameters::class)
+    public function __construct()
     {
         parent::__construct(
+            name: 'value',
+            description: 'Value to convert.',
+            in: 'query',
             required: true,
-            content: new JsonContent(ref: $ref)
+            schema: new Schema(
+                anyOf: [
+                    new Schema(type: 'integer', format: 'int32'),
+                    new Schema(type: 'number', format: 'float'),
+                ],
+            ),
+            example: 5
         );
     }
 }
diff --git a/...Attribute/Response/ConvertedValueJson.php → ...Attribute/Response/ConvertedValueJson.php b/...Attribute/Response/ConvertedValueJson.php → ...Attribute/Response/ConvertedValueJson.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Response;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Response;
 
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Property;

diff --git a/...ibute/Response/QuantityValueUnitsJson.php → ...ibute/Response/QuantityValueUnitsJson.php b/...ibute/Response/QuantityValueUnitsJson.php → ...ibute/Response/QuantityValueUnitsJson.php
@@ -14,12 +14,12 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Response;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Response;
 
 use OpenApi\Attributes\Items;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Property;
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\QuantityValueUnit;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Schema\QuantityValueUnit;
 
 /**
  * @internal

diff --git a/...er/QuantityValue/ConvertAllController.php → ...er/QuantityValue/ConvertAllController.php b/...er/QuantityValue/ConvertAllController.php → ...er/QuantityValue/ConvertAllController.php
@@ -14,25 +14,26 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Controller\QuantityValue;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Controller\QuantityValue;
 
+use OpenApi\Attributes\Get;
 use OpenApi\Attributes\JsonContent;
-use OpenApi\Attributes\Post;
-use Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Request\ConvertRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\ConvertAllParameters;
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\ConvertedQuantityValues;
-use Pimcore\Bundle\StudioBackendBundle\Class\Service\QuantityValueServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\DatabaseException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\TextFieldParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Parameter\Query\ValueParameter;
+use Pimcore\Bundle\StudioBackendBundle\Unit\MappedParameter\ConvertAllUnitsParameter;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Schema\ConvertedQuantityValues;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Service\QuantityValueServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
 use Pimcore\Bundle\StudioBackendBundle\Util\Trait\ElementProviderTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
+use Symfony\Component\HttpKernel\Attribute\MapQueryString;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
@@ -56,28 +57,34 @@ public function __construct(
      * @throws DatabaseException|NotFoundException
      */
     #[Route(
-        '/class/quantity-value/convert-all',
-        name: 'pimcore_studio_api_get_class_quantity_value_convert_all',
-        methods: ['POST']
+        '/unit/quantity-value/convert-all',
+        name: 'pimcore_studio_api_unit_quantity_value_convert_all',
+        methods: ['GET']
     )]
     #[IsGranted(UserPermissions::DATA_OBJECTS->value)]
-    #[Post(
-        path: self::PREFIX . '/class/quantity-value/convert-all',
-        operationId: 'class_quantity_value_unit_convert_all',
-        description: 'class_quantity_value_unit_convert_all_description',
-        summary: 'class_quantity_value_unit_convert_all_summary',
-        tags: [Tags::ClassDefinition->value]
+    #[Get(
+        path: self::PREFIX . '/unit/quantity-value/convert-all',
+        operationId: 'unit_quantity_value_convert_all',
+        description: 'unit_quantity_value_convert_all_description',
+        summary: 'unit_quantity_value_convert_all_summary',
+        tags: [Tags::Units->value]
     )]
+    #[TextFieldParameter(
+        name: 'fromUnitId',
+        description: 'Id of the unit to convert from',
+        required: true
+    )]
+    #[ValueParameter]
     #[SuccessResponse(
-        description: 'class_quantity_value_unit_convert_all_success_response',
+        description: 'unit_quantity_value_convert_all_success_response',
         content: new JsonContent(ref: ConvertedQuantityValues::class)
     )]
-    #[ConvertRequestBody(ConvertAllParameters::class)]
     #[DefaultResponses([
         HttpResponseCodes::UNAUTHORIZED,
         HttpResponseCodes::NOT_FOUND,
+        HttpResponseCodes::INTERNAL_SERVER_ERROR,
     ])]
-    public function covertAll(#[MapRequestPayload] ConvertAllParameters $parameters): JsonResponse
+    public function covertAll(#[MapQueryString] ConvertAllUnitsParameter $parameters): JsonResponse
     {
         return $this->jsonResponse($this->quantityValueService->convertAllUnits($parameters));
     }

diff --git a/...oller/QuantityValue/ConvertController.php → ...oller/QuantityValue/ConvertController.php b/...oller/QuantityValue/ConvertController.php → ...oller/QuantityValue/ConvertController.php
@@ -14,24 +14,25 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Controller\QuantityValue;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Controller\QuantityValue;
 
-use OpenApi\Attributes\Post;
-use Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Request\ConvertRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Response\ConvertedValueJson;
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\ConvertParameters;
-use Pimcore\Bundle\StudioBackendBundle\Class\Service\QuantityValueServiceInterface;
+use OpenApi\Attributes\Get;
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\DatabaseException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\TextFieldParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Parameter\Query\ValueParameter;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Response\ConvertedValueJson;
+use Pimcore\Bundle\StudioBackendBundle\Unit\MappedParameter\ConvertUnitParameter;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Service\QuantityValueServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
 use Pimcore\Bundle\StudioBackendBundle\Util\Trait\ElementProviderTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
+use Symfony\Component\HttpKernel\Attribute\MapQueryString;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
@@ -55,28 +56,39 @@ public function __construct(
      * @throws DatabaseException|NotFoundException
      */
     #[Route(
-        '/class/quantity-value/convert',
-        name: 'pimcore_studio_api_get_class_quantity_value_convert',
-        methods: ['POST']
+        '/unit/quantity-value/convert',
+        name: 'pimcore_studio_api_unit_quantity_value_convert',
+        methods: ['GET']
     )]
     #[IsGranted(UserPermissions::DATA_OBJECTS->value)]
-    #[Post(
-        path: self::PREFIX . '/class/quantity-value/convert',
-        operationId: 'class_quantity_value_unit_convert',
-        description: 'class_quantity_value_unit_convert_description',
-        summary: 'class_quantity_value_unit_convert_summary',
-        tags: [Tags::ClassDefinition->value]
+    #[Get(
+        path: self::PREFIX . '/unit/quantity-value/convert',
+        operationId: 'unit_quantity_value_convert',
+        description: 'unit_quantity_value_convert_description',
+        summary: 'unit_quantity_value_convert_summary',
+        tags: [Tags::Units->value]
     )]
+    #[TextFieldParameter(
+        name: 'fromUnitId',
+        description: 'Id of the unit to convert from',
+        required: true
+    )]
+    #[TextFieldParameter(
+        name: 'toUnitId',
+        description: 'Id of the unit to convert to',
+        required: true
+    )]
+    #[ValueParameter]
     #[SuccessResponse(
-        description: 'class_quantity_value_unit_convert_success_response',
+        description: 'unit_quantity_value_convert_success_response',
         content: new ConvertedValueJson()
     )]
-    #[ConvertRequestBody]
     #[DefaultResponses([
         HttpResponseCodes::UNAUTHORIZED,
         HttpResponseCodes::NOT_FOUND,
+        HttpResponseCodes::INTERNAL_SERVER_ERROR,
     ])]
-    public function convert(#[MapRequestPayload] ConvertParameters $parameters): JsonResponse
+    public function convert(#[MapQueryString] ConvertUnitParameter $parameters): JsonResponse
     {
         return $this->jsonResponse(['data' => $this->quantityValueService->convertUnit($parameters)]);
     }

diff --git a/...ller/QuantityValue/UnitListController.php → ...ller/QuantityValue/UnitListController.php b/...ller/QuantityValue/UnitListController.php → ...ller/QuantityValue/UnitListController.php
@@ -14,15 +14,15 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Controller\QuantityValue;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Controller\QuantityValue;
 
 use OpenApi\Attributes\Get;
-use Pimcore\Bundle\StudioBackendBundle\Class\Attribute\Response\QuantityValueUnitsJson;
-use Pimcore\Bundle\StudioBackendBundle\Class\Service\QuantityValueServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Attribute\Response\QuantityValueUnitsJson;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Service\QuantityValueServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
 use Pimcore\Bundle\StudioBackendBundle\Util\Trait\ElementProviderTrait;
@@ -47,20 +47,20 @@ public function __construct(
     }
 
     #[Route(
-        '/class/quantity-value/unit-list',
-        name: 'pimcore_studio_api_get_class_quantity_value_unit_list',
+        '/unit/quantity-value/unit-list',
+        name: 'pimcore_studio_api_unit_quantity_value_list',
         methods: ['GET']
     )]
     #[IsGranted(UserPermissions::DATA_OBJECTS->value)]
     #[Get(
-        path: self::PREFIX . '/class/quantity-value/unit-list',
-        operationId: 'class_quantity_value_unit_list',
-        description: 'class_quantity_value_unit_list_description',
-        summary: 'class_quantity_value_unit_list_summary',
-        tags: [Tags::ClassDefinition->value]
+        path: self::PREFIX . '/unit/quantity-value/unit-list',
+        operationId: 'unit_quantity_value_list',
+        description: 'unit_quantity_value_list_description',
+        summary: 'unit_quantity_value_list_summary',
+        tags: [Tags::Units->value]
     )]
     #[SuccessResponse(
-        description: 'class_quantity_value_unit_list_success_response',
+        description: 'unit_quantity_value_list_success_response',
         content: new QuantityValueUnitsJson()
     )]
     #[DefaultResponses([

diff --git a/...Response/QuantityValueConversionEvent.php → ...Response/QuantityValueConversionEvent.php b/...Response/QuantityValueConversionEvent.php → ...Response/QuantityValueConversionEvent.php
@@ -14,10 +14,10 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Event\PreResponse;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Event\PreResponse;
 
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\ConvertedQuantityValues;
 use Pimcore\Bundle\StudioBackendBundle\Event\AbstractPreResponseEvent;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Schema\ConvertedQuantityValues;
 
 final class QuantityValueConversionEvent extends AbstractPreResponseEvent
 {

diff --git a/...nt/PreResponse/QuantityValueUnitEvent.php → ...nt/PreResponse/QuantityValueUnitEvent.php b/...nt/PreResponse/QuantityValueUnitEvent.php → ...nt/PreResponse/QuantityValueUnitEvent.php
@@ -14,10 +14,10 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Class\Event\PreResponse;
+namespace Pimcore\Bundle\StudioBackendBundle\Unit\Event\PreResponse;
 
-use Pimcore\Bundle\StudioBackendBundle\Class\Schema\QuantityValueUnit;
 use Pimcore\Bundle\StudioBackendBundle\Event\AbstractPreResponseEvent;
+use Pimcore\Bundle\StudioBackendBundle\Unit\Schema\QuantityValueUnit;
 
 final class QuantityValueUnitEvent extends AbstractPreResponseEvent
 {