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

epitre · epitre · commit eb1de08238f8 · 2020-07-01T09:38:30.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,11 @@ public function getEnabledTransitions(object $subject, string $name = null): arr
         return $this->workflowRegistry->get($subject, $name)->getEnabledTransitions($subject);
     }
 
+    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/Bridge/Twig/composer.json b/src/Symfony/Bridge/Twig/composer.json
@@ -42,7 +42,7 @@
         "symfony/console": "^4.4|^5.0",
         "symfony/expression-language": "^4.4|^5.0",
         "symfony/web-link": "^4.4|^5.0",
-        "symfony/workflow": "^4.4|^5.0",
+        "symfony/workflow": "^5.2",
         "twig/cssinliner-extra": "^2.12",
         "twig/inky-extra": "^2.12",
         "twig/markdown-extra": "^2.12"
@@ -53,7 +53,7 @@
         "symfony/http-foundation": "<4.4",
         "symfony/http-kernel": "<4.4",
         "symfony/translation": "<5.0",
-        "symfony/workflow": "<4.4"
+        "symfony/workflow": "<5.2"
     },
     "suggest": {
         "symfony/finder": "",
diff --git a/src/Symfony/Component/Workflow/Tests/WorkflowTest.php b/src/Symfony/Component/Workflow/Tests/WorkflowTest.php
@@ -592,6 +592,21 @@ public function testGetEnabledTransitions()
         $this->assertSame('t5', $transitions[0]->getName());
     }
 
+    public function testGetEnabledTransition()
+    {
+        $definition = $this->createComplexWorkflowDefinition();
+        $subject = new Subject();
+        $workflow = new Workflow($definition, new MethodMarkingStore());
+
+        $subject->setMarking(['d' => 1]);
+        $transition = $workflow->getEnabledTransition($subject, 't3');
+        $this->assertInstanceOf(Transition::class, $transition);
+        $this->assertSame('t3', $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,24 @@ public function getEnabledTransitions(object $subject)
         return $enabledTransitions;
     }
 
+    public function getEnabledTransition(object $subject, string $name): ?Transition
+    {
+        $marking = $this->getMarking($subject);
+
+        foreach ($this->definition->getTransitions() as $transition) {
+            if ($transition->getName() !== $name) {
+                continue;
+            }
+            $transitionBlockerList = $this->buildTransitionBlockerListForTransition($subject, $marking, $transition);
+            if (!$transitionBlockerList->isEmpty()) {
+                continue;
+            }
+            return $transition;
+        }
+
+        return null;
+    }
+
     /**
      * {@inheritdoc}
      */
