vendor/shopware/core/System/StateMachine/Api/StateMachineActionController.php line 51

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\StateMachine\Api;
  5. use Shopware\Core\Framework\Api\Response\ResponseFactoryInterface;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  9. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  10. use Shopware\Core\Framework\Routing\Annotation\Since;
  11. use Shopware\Core\System\StateMachine\Aggregation\StateMachineState\StateMachineStateDefinition;
  12. use Shopware\Core\System\StateMachine\Aggregation\StateMachineTransition\StateMachineTransitionEntity;
  13. use Shopware\Core\System\StateMachine\StateMachineRegistry;
  14. use Shopware\Core\System\StateMachine\Transition;
  15. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  16. use Symfony\Component\HttpFoundation\JsonResponse;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\Routing\Annotation\Route;
  21. /**
  22.  * @Route(defaults={"_routeScope"={"api"}})
  23.  */
  24. class StateMachineActionController extends AbstractController
  25. {
  26.     /**
  27.      * @var StateMachineRegistry
  28.      */
  29.     protected $stateMachineRegistry;
  31.     /**
  32.      * @var DefinitionInstanceRegistry
  33.      */
  34.     private $definitionInstanceRegistry;
  36.     /**
  37.      * @internal
  38.      */
  39.     public function __construct(
  40.         StateMachineRegistry $stateMachineRegistry,
  41.         DefinitionInstanceRegistry $definitionInstanceRegistry
  42.     ) {
  43.         $this->stateMachineRegistry = $stateMachineRegistry;
  44.         $this->definitionInstanceRegistry = $definitionInstanceRegistry;
  45.     }
  47.     /**
  48.      * @Since("6.0.0.0")
  49.      * @Route("/api/_action/state-machine/{entityName}/{entityId}/state", name="api.state_machine.states", methods={"GET"})
  50.      */
  51.     public function getAvailableTransitions(
  52.         Request $request,
  53.         Context $context,
  54.         string $entityName,
  55.         string $entityId
  56.     ): JsonResponse {
  57.         $stateFieldName = (string) $request->query->get('stateFieldName', 'stateId');
  59.         $availableTransitions = $this->stateMachineRegistry->getAvailableTransitions(
  60.             $entityName,
  61.             $entityId,
  62.             $stateFieldName,
  63.             $context
  64.         );
  66.         $transitionsJson = [];
  67.         /** @var StateMachineTransitionEntity $transition */
  68.         foreach ($availableTransitions as $transition) {
  69.             $transitionsJson[] = [
  70.                 'name' => $transition->getToStateMachineState()->getName(),
  71.                 'technicalName' => $transition->getToStateMachineState()->getTechnicalName(),
  72.                 'actionName' => $transition->getActionName(),
  73.                 'fromStateName' => $transition->getFromStateMachineState()->getTechnicalName(),
  74.                 'toStateName' => $transition->getToStateMachineState()->getTechnicalName(),
  75.                 'url' => $this->generateUrl('api.state_machine.transition_state', [
  76.                     'entityName' => $entityName,
  77.                     'entityId' => $entityId,
  78.                     'version' => $request->attributes->get('version'),
  79.                     'transition' => $transition->getActionName(),
  80.                 ]),
  81.             ];
  82.         }
  84.         return new JsonResponse([
  85.             'transitions' => $transitionsJson,
  86.         ]);
  87.     }
  89.     /**
  90.      * @Since("6.0.0.0")
  91.      * @Route("/api/_action/state-machine/{entityName}/{entityId}/state/{transition}", name="api.state_machine.transition_state", methods={"POST"})
  92.      */
  93.     public function transitionState(
  94.         Request $request,
  95.         Context $context,
  96.         ResponseFactoryInterface $responseFactory,
  97.         string $entityName,
  98.         string $entityId,
  99.         string $transition
  100.     ): Response {
  101.         $stateFieldName = (string) $request->query->get('stateFieldName', 'stateId');
  102.         $stateMachineStateCollection = $this->stateMachineRegistry->transition(
  103.             new Transition(
  104.                 $entityName,
  105.                 $entityId,
  106.                 $transition,
  107.                 $stateFieldName
  108.             ),
  109.             $context
  110.         );
  112.         return $responseFactory->createDetailResponse(
  113.             new Criteria(),
  114.             $stateMachineStateCollection->get('toPlace'),
  115.             $this->definitionInstanceRegistry->get(StateMachineStateDefinition::class),
  116.             $request,
  117.             $context
  118.         );
  119.     }
  120. }