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

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