Removed StepDirectionAwareInterface & use StepAwareInterface: Simplified DefaultStepController

Author: Tobias Wojtylak

src/Controller/DefaultStepController.php

@@ -9,36 +9,30 @@
 
 namespace solutionDrive\MultiStepBundle\Controller;
 
+use solutionDrive\MultiStepBundle\Context\FlowContext;
+use solutionDrive\MultiStepBundle\Context\FlowContextInterface;
 use solutionDrive\MultiStepBundle\Exception\NoNextOrPreviousStepException;
 use solutionDrive\MultiStepBundle\Model\MultiStepFlowInterface;
 use solutionDrive\MultiStepBundle\Model\MultiStepInterface;
+use solutionDrive\MultiStepBundle\Router\MultistepRouterInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
-class DefaultStepController extends Controller implements TemplateAwareControllerInterface, StepDirectionAwareInterface, FlowAwareInterface, StepAwareInterface
+class DefaultStepController extends Controller implements TemplateAwareControllerInterface, StepAwareInterface, FlowAwareInterface
 {
     /** @var string */
     private $template = 'MultiStepBundle::default_step.html.twig';
 
     /** @var MultiStepFlowInterface */
     private $flow;
 
-    /** @var MultiStepInterface */
-    private $step;
+    /** @var FlowContext */
+    private $flowContext;
 
-    /** @var MultiStepInterface|null */
-    private $previousStep;
-
-    /** @var MultiStepInterface|null */
-    private $nextStep;
-
-    /** @var string|null */
-    private $previousStepLink;
-
-    /** @var string|null */
-    private $nextStepLink;
+    /** @var MultistepRouterInterface */
+    private $router;
 
     public function renderAction(Request $request): Response
     {
@@ -77,10 +71,7 @@ public function getTemplateVariables(): array
      */
     public function redirectToNextStep(int $statusCode = 302): RedirectResponse
     {
-        if (null === $this->nextStepLink) {
-            throw new NoNextOrPreviousStepException();
-        }
-        return $this->redirect($this->nextStepLink, $statusCode);
+        return $this->redirectToStep($this->getNextStepLink(), $statusCode);
     }
 
     /**
@@ -89,26 +80,32 @@ public function redirectToNextStep(int $statusCode = 302): RedirectResponse
      */
     public function redirectToPreviousStep(int $statusCode = 302): RedirectResponse
     {
-        if (null === $this->previousStepLink) {
+        return $this->redirectToStep($this->getPreviousStep(), $statusCode);
+    }
+
+
+    protected function redirectToStep(MultiStepInterface $step, int $statusCode)
+    {
+        if (null === $step) {
             throw new NoNextOrPreviousStepException();
         }
-        return $this->redirect($this->previousStepLink, $statusCode);
+        return $this->redirect($this->router->generateStepLink($step), $statusCode);
     }
 
     /**
      * Returns true if there is a next step in the flow.
      */
     public function hasNextStep(): bool
     {
-        return null !== $this->nextStep;
+        return $this->flowContext->hasNextStep();
     }
 
     /**
      * Returns true if there is a previous step in the flow.
      */
     public function hasPreviousStep(): bool
     {
-        return null !== $this->previousStep;
+        return $this->flowContext->hasPreviousStep();
     }
 
     /**
@@ -130,61 +127,57 @@ public function setTemplate(string $template): void
 
     public function getNextStep(): ?MultiStepInterface
     {
-        return $this->nextStep;
-    }
-
-    public function setNextStep(?MultiStepInterface $step): void
-    {
-        $this->nextStep = $step;
+        return $this->flowContext->getNextStep();
     }
 
     public function getPreviousStep(): ?MultiStepInterface
     {
-        return $this->previousStep;
+        return $this->flowContext->getPreviousStep();
     }
 
-    public function setPreviousStep(?MultiStepInterface $step): void
+    public function getNextStepLink(): ?string
     {
-        $this->previousStep = $step;
+        return $this->hasNextStep() ? $this->router->generateStepLink($this->getNextStep()) : null;
     }
 
-    public function getNextStepLink(): ?string
+
+    public function getPreviousStepLink(): ?string
     {
-        return $this->nextStepLink;
+        return $this->hasPreviousStep() ? $this->router->generateStepLink($this->getPreviousStep()) : null;
     }
 
-    public function setNextStepLink(?string $link): void
+    public function getFlow(): ?MultiStepFlowInterface
     {
-        $this->nextStepLink = $link;
+        return $this->flow;
     }
 
-    public function getPreviousStepLink(): ?string
+    public function setFlow(?MultiStepFlowInterface $flow): void
     {
-        return $this->previousStepLink;
+        $this->flow = $flow;
     }
 
-    public function setPreviousStepLink(?string $link): void
+    public function getStep(): ?MultiStepInterface
     {
-        $this->previousStepLink = $link;
+        return $this->flowContext->getCurrentStep();
     }
 
-    public function getFlow(): ?MultiStepFlowInterface
+    public function getFlowContext(): FlowContextInterface
     {
-        return $this->flow;
+        return $this->flowContext;
     }
 
-    public function setFlow(?MultiStepFlowInterface $flow): void
+    public function setFlowContext(FlowContextInterface $flowContext): void
     {
-        $this->flow = $flow;
+        $this->flowContext = $flowContext;
     }
 
-    public function getStep(): ?MultiStepInterface
+    public function setRouter(MultistepRouterInterface $router): void
     {
-        return $this->step;
+        $this->router = $router;
     }
 
-    public function setStep(?MultiStepInterface $step): void
+    public function getRouter(): MultistepRouterInterface
     {
-        $this->step = $step;
+        return $this->router;
     }
 }

src/Controller/MultiStepController.php

@@ -9,14 +9,15 @@
 
 namespace solutionDrive\MultiStepBundle\Controller;
 
+use solutionDrive\MultiStepBundle\Factory\FlowContextFactoryInterface;
+use solutionDrive\MultiStepBundle\Factory\MultistepRouterFactoryInterface;
 use solutionDrive\MultiStepBundle\Registry\MultiStepFlowRegistryInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
-use Symfony\Component\Routing\RouterInterface;
 
 class MultiStepController extends Controller
 {
@@ -28,27 +29,40 @@ class MultiStepController extends Controller
 
     /** @var ArgumentResolverInterface */
     private $argumentResolver;
+    /**
+     * @var FlowContextFactoryInterface
+     */
+    private $flowContextFactory;
+    /**
+     * @var MultistepRouterFactoryInterface
+     */
+    private $stepRouterFactory;
 
     public function __construct(
         MultiStepFlowRegistryInterface $flowRegistry,
         ControllerResolverInterface $controllerResolver,
-        ArgumentResolverInterface $argumentResolver
+        ArgumentResolverInterface $argumentResolver,
+        FlowContextFactoryInterface $flowContextFactory,
+        MultistepRouterFactoryInterface $stepRouterFactory
     ) {
         $this->flowRegistry = $flowRegistry;
         $this->controllerResolver = $controllerResolver;
         $this->argumentResolver = $argumentResolver;
+        $this->flowContextFactory = $flowContextFactory;
+        $this->stepRouterFactory = $stepRouterFactory;
     }
 
     public function stepAction(Request $request, string $flow_slug, string $step_slug): Response
     {
         $flow = $this->flowRegistry->getFlowBySlug($flow_slug);
-        $step = $flow->getStepBySlug($step_slug);
+        $flowContext = $this->flowContextFactory->create($flow, $step_slug);
+        $router = $this->stepRouterFactory->create($request, $flow_slug);
+
+        $step = $flowContext->getCurrentStep();
         $configuredController = $step->getControllerAction();
 
         $request->attributes->set('_controller', $configuredController);
 
-        $currentRoute = $request->get('_route');
-
         $callableController = $this->controllerResolver->getController($request);
         $arguments = $this->argumentResolver->getArguments($request, $callableController);
 
@@ -59,40 +73,17 @@ public function stepAction(Request $request, string $flow_slug, string $step_slu
             $controller->setTemplate($step->getTemplate());
         }
 
-        // set previous and next steps
-        if ($controller instanceof StepDirectionAwareInterface) {
-            /** @var RouterInterface $router */
-            $router = $this->get('router');
-            $nextStep = $flow->getStepAfter($step);
-            $previousStep = $flow->getStepBefore($step);
-
-            if (null !== $nextStep) {
-                $nextStepLink = $router->generate(
-                    $currentRoute,
-                    ['flow_slug' => $flow_slug, 'step_slug' => $nextStep->getSlug()]
-                );
-                $controller->setNextStep($nextStep);
-                $controller->setNextStepLink($nextStepLink);
-            }
-            if (null !== $previousStep) {
-                $previousStepLink = $router->generate(
-                    $currentRoute,
-                    ['flow_slug' => $flow_slug, 'step_slug' => $previousStep->getSlug()]
-                );
-                $controller->setPreviousStep($previousStep);
-                $controller->setPreviousStepLink($previousStepLink);
-            }
+        // set flow context
+        if ($controller instanceof StepAwareInterface) {
+            $controller->setFlowContext($flowContext);
+            $controller->setRouter($router);
         }
 
         // set flow
         if ($controller instanceof FlowAwareInterface) {
             $controller->setFlow($flow);
         }
 
-        // set step
-        if ($controller instanceof StepAwareInterface) {
-            $controller->setStep($step);
-        }
 
         return call_user_func_array($callableController, $arguments);
     }

src/Controller/StepAwareInterface.php

@@ -9,11 +9,27 @@
 
 namespace solutionDrive\MultiStepBundle\Controller;
 
+use solutionDrive\MultiStepBundle\Context\FlowContextInterface;
 use solutionDrive\MultiStepBundle\Model\MultiStepInterface;
+use solutionDrive\MultiStepBundle\Router\MultistepRouterInterface;
 
 interface StepAwareInterface
 {
-    public function getStep(): ?MultiStepInterface;
+    public function setFlowContext(FlowContextInterface $flowContext): void;
+
+    public function getFlowContext(): FlowContextInterface;
+
+    public function setRouter(MultistepRouterInterface $router): void;
+
+    public function getRouter(): MultistepRouterInterface;
+
+    public function getNextStep(): ?MultiStepInterface;
 
-    public function setStep(?MultiStepInterface $step): void;
+    public function getNextStepLink(): ?string;
+
+    public function getPreviousStep(): ?MultiStepInterface;
+
+    public function getPreviousStepLink(): ?string;
+
+    public function getStep(): ?MultiStepInterface;
 }