Workflow listing API: names, places Endpoints

config/element_workflow.yaml

@@ -26,6 +26,9 @@ services:
   Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowElementsServiceInterface:
     class: Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowElementsService
 
+  Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowMetaServiceInterface:
+    class: Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowMetaService
+
   # Repositories
   Pimcore\Bundle\StudioBackendBundle\Workflow\Repository\WorkflowElementsRepositoryInterface:
     class: Pimcore\Bundle\StudioBackendBundle\Workflow\Repository\WorkflowElementsRepository

src/Workflow/Attribute/Response/Content/WorkflowStringListContent.php

@@ -0,0 +1,34 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Attribute\Response\Content;
+
+use OpenApi\Attributes\JsonContent;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\Attribute\Response\Property\WorkflowStringCollection;
+
+/**
+ * @internal
+ */
+final class WorkflowStringListContent extends JsonContent
+{
+    public function __construct()
+    {
+        parent::__construct(
+            required: ['items'],
+            properties: [
+                new WorkflowStringCollection(),
+            ],
+            type: 'object',
+        );
+    }
+}

src/Workflow/Attribute/Response/Property/WorkflowStringCollection.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Attribute\Response\Property;
+
+use OpenApi\Attributes\Items;
+use OpenApi\Attributes\Property;
+
+/**
+ * @internal
+ */
+final class WorkflowStringCollection extends Property
+{
+    public function __construct()
+    {
+        parent::__construct(
+            'items',
+            title: 'items',
+            type: 'array',
+            items: new Items(type: 'string'),
+        );
+    }
+}

src/Workflow/Controller/NamesCollectionController.php

@@ -0,0 +1,64 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Controller;
+
+use OpenApi\Attributes\Get;
+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\Util\Constant\HttpResponseCodes;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\Attribute\Response\Content\WorkflowStringListContent;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowMetaServiceInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ */
+final class NamesCollectionController extends AbstractApiController
+{
+    private const string ROUTE = '/workflows/names';
+
+    public function __construct(
+        SerializerInterface $serializer,
+        private readonly WorkflowMetaServiceInterface $workflowMetaService,
+    ) {
+        parent::__construct($serializer);
+    }
+
+    #[Route(path: self::ROUTE, name: 'pimcore_studio_api_workflows_names', methods: ['GET'])]
+    //#[IsGranted('STUDIO_API')]
+    #[Get(
+        path: self::PREFIX . self::ROUTE,
+        operationId: 'workflow_get_names',
+        description: 'workflow_get_names_description',
+        summary: 'workflow_get_names_summary',
+        tags: [Tags::Workflows->name]
+    )]
+    #[SuccessResponse(
+        description: 'workflow_get_names_success_response',
+        content: new WorkflowStringListContent()
+    )]
+    #[DefaultResponses([
+        HttpResponseCodes::UNAUTHORIZED,
+    ])]
+    public function getNames(): JsonResponse
+    {
+        return $this->jsonResponse([
+            'items' => $this->workflowMetaService->getWorkflowNames(),
+        ]);
+    }
+}

src/Workflow/Controller/PlacesCollectionController.php

@@ -0,0 +1,69 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Controller;
+
+use OpenApi\Attributes\Get;
+use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Query\StringParameter;
+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\Util\Constant\HttpResponseCodes;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\Attribute\Response\Content\WorkflowStringListContent;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\MappedParameter\WorkflowPlacesParameters;
+use Pimcore\Bundle\StudioBackendBundle\Workflow\Service\WorkflowMetaServiceInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Attribute\MapQueryString;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ */
+final class PlacesCollectionController extends AbstractApiController
+{
+    private const string ROUTE = '/workflows/places';
+
+    public function __construct(
+        SerializerInterface $serializer,
+        private readonly WorkflowMetaServiceInterface $workflowMetaService,
+    ) {
+        parent::__construct($serializer);
+    }
+
+    #[Route(path: self::ROUTE, name: 'pimcore_studio_api_workflows_places', methods: ['GET'])]
+    //#[IsGranted('STUDIO_API')]
+    #[Get(
+        path: self::PREFIX . self::ROUTE,
+        operationId: 'workflow_get_places',
+        description: 'workflow_get_places_description',
+        summary: 'workflow_get_places_summary',
+        tags: [Tags::Workflows->name]
+    )]
+    #[StringParameter('workflowName', 'product_workflow', 'workflow_get_places_workflow_name')]
+    #[SuccessResponse(
+        description: 'workflow_get_places_success_response',
+        content: new WorkflowStringListContent()
+    )]
+    #[DefaultResponses([
+        HttpResponseCodes::UNAUTHORIZED,
+    ])]
+    public function getPlaces(
+        #[MapQueryString] WorkflowPlacesParameters $parameters = new WorkflowPlacesParameters()
+    ): JsonResponse {
+        return $this->jsonResponse([
+            'items' => $this->workflowMetaService->getPlaces($parameters->getWorkflowName()),
+        ]);
+    }
+}

src/Workflow/MappedParameter/WorkflowPlacesParameters.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\MappedParameter;
+
+/**
+ * @internal
+ */
+final readonly class WorkflowPlacesParameters
+{
+    public function __construct(
+        private string $workflowName = '',
+    ) {
+    }
+
+    public function getWorkflowName(): string
+    {
+        return $this->workflowName;
+    }
+}

src/Workflow/Service/WorkflowMetaService.php

@@ -0,0 +1,54 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Service;
+
+use Pimcore\Workflow\Manager;
+use function array_keys;
+use function in_array;
+
+/**
+ * @internal
+ */
+final readonly class WorkflowMetaService implements WorkflowMetaServiceInterface
+{
+    public function __construct(
+        private Manager $workflowManager,
+    ) {
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getWorkflowNames(): array
+    {
+        return $this->workflowManager->getAllWorkflows();
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getPlaces(string $workflowName): array
+    {
+        if ($workflowName === '' || !in_array($workflowName, $this->workflowManager->getAllWorkflows(), true)) {
+            return [];
+        }
+
+        $workflow = $this->workflowManager->getWorkflowByName($workflowName);
+        if ($workflow === null) {
+            return [];
+        }
+
+        return array_keys($workflow->getDefinition()->getPlaces());
+    }
+}

src/Workflow/Service/WorkflowMetaServiceInterface.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Workflow\Service;
+
+/**
+ * @internal
+ */
+interface WorkflowMetaServiceInterface
+{
+    /**
+     * @return string[]
+     */
+    public function getWorkflowNames(): array;
+
+    /**
+     * @return string[]
+     */
+    public function getPlaces(string $workflowName): array;
+}