Added Function (and Twig extension) to retrieve a specific transition

epitre · epitre · commit f9074aa72bf7 · 2020-06-26T16:05:05.000+02:00
You can now easily retrieve a specific transition. Useful when you want the metadata of a specific transition.
diff --git a/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php b/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php
@@ -39,6 +39,7 @@ public function getFunctions(): array
         return [
             new TwigFunction('workflow_can', [$this, 'canTransition']),
             new TwigFunction('workflow_transitions', [$this, 'getEnabledTransitions']),
+            new TwigFunction('workflow_transition', [$this, 'getEnabledTransition']),
             new TwigFunction('workflow_has_marked_place', [$this, 'hasMarkedPlace']),
             new TwigFunction('workflow_marked_places', [$this, 'getMarkedPlaces']),
             new TwigFunction('workflow_metadata', [$this, 'getMetadata']),
@@ -64,6 +65,16 @@ public function getEnabledTransitions(object $subject, string $name = null): arr
         return $this->workflowRegistry->get($subject, $name)->getEnabledTransitions($subject);
     }
 
+    /**
+     * Returns a transition or null.
+     *
+     * @return Transition|null Enabled transition asked for
+     */
+    public function getEnabledTransition(object $subject, string $transition, string $name = null): ?Transition
+    {
+        return $this->workflowRegistry->get($subject, $name)->getEnabledTransition($subject, $transition);
+    }
+
     /**
      * Returns true if the place is marked.
      */
diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/WorkflowExtensionTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/WorkflowExtensionTest.php
@@ -81,6 +81,16 @@ public function testGetEnabledTransitions()
         $this->assertSame('t1', $transitions[0]->getName());
     }
 
+    public function testGetEnabledTransition()
+    {
+        $subject = new Subject();
+
+        $transition = $this->extension->getEnabledTransition($subject, 't1');
+
+        $this->assertInstanceOf(Transition::class, $transition);
+        $this->assertSame('t1', $transition->getName());
+    }
+
     public function testHasMarkedPlace()
     {
         $subject = new Subject(['ordered' => 1, 'waiting_for_payment' => 1]);
diff --git a/src/Symfony/Component/Workflow/Tests/WorkflowTest.php b/src/Symfony/Component/Workflow/Tests/WorkflowTest.php
@@ -592,6 +592,32 @@ public function testGetEnabledTransitions()
         $this->assertSame('t5', $transitions[0]->getName());
     }
 
+    public function testGetEnabledTransition()
+    {
+        $definition = $this->createComplexWorkflowDefinition();
+        $subject = new Subject();
+        $eventDispatcher = new EventDispatcher();
+        $eventDispatcher->addListener('workflow.workflow_name.guard.t1', function (GuardEvent $event) {
+            $event->setBlocked(true);
+        });
+        $workflow = new Workflow($definition, new MethodMarkingStore(), $eventDispatcher, 'workflow_name');
+
+        $this->assertEmpty($workflow->getEnabledTransitions($subject));
+
+        $subject->setMarking(['d' => 1]);
+        $transition = $workflow->getEnabledTransition($subject, 't3');
+        $this->assertInstanceOf(Transition::class, $transition);
+        $this->assertSame('t3', $transition->getName());
+
+        $subject->setMarking(['c' => 1, 'e' => 1]);
+        $transition = $workflow->getEnabledTransition($subject, 't5');
+        $this->assertInstanceOf(Transition::class, $transition);
+        $this->assertSame('t5', $transition->getName());
+
+        $transition = $workflow->getEnabledTransition($subject, 'does_not_exist');
+        $this->assertNull($transition);
+    }
+
     public function testGetEnabledTransitionsWithSameNameTransition()
     {
         $definition = $this->createWorkflowWithSameNameTransition();
diff --git a/src/Symfony/Component/Workflow/Workflow.php b/src/Symfony/Component/Workflow/Workflow.php
@@ -235,6 +235,23 @@ public function getEnabledTransitions(object $subject)
         return $enabledTransitions;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getEnabledTransition(object $subject, string $name)
+    {
+        $marking = $this->getMarking($subject);
+
+        foreach ($this->definition->getTransitions() as $transition) {
+            $transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
+            if ($transitionBlockerList->isEmpty() && $transition->getName() === $name) {
+                return $transition;
+            }
+        }
+
+        return null;
+    }
+
     /**
      * {@inheritdoc}
      */
