feature #41292 [Workflow] Add support for getting updated context after a transition (lyrixx)

fabpot · fabpot · commit 64025726d3cb · 2021-07-03T07:28:27.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Workflow] Add support for getting updated context after a transition | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | I have a listener that lock the transition. Then, I need to give this lock to my consumer. ATM, there is no easy way to pass a new resource from a listener to the caller. I could add a new `tmpLock` property on my subject (this is what I did temporary), but I'm not confortable with this hack. By adding the final context (it could be updated, that the point of listener) to the marking, I could easily get data back. Finally, the PHP doc of WorkflowInterface::apply() tells us: ```php * `@return` Marking The new Marking ``` So I think it's legit to add also the new context Commits ------- 571c75e [Workflown] Add support for getting updated context after a transition
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Add support for getting updated context after a transition
+
 5.3
 ---
 
diff --git a/src/Symfony/Component/Workflow/Marking.php b/src/Symfony/Component/Workflow/Marking.php
@@ -19,6 +19,7 @@
 class Marking
 {
     private $places = [];
+    private $context = null;
 
     /**
      * @param int[] $representation Keys are the place name and values should be 1
@@ -49,4 +50,20 @@ public function getPlaces()
     {
         return $this->places;
     }
+
+    /**
+     * @internal
+     */
+    public function setContext(array $context): void
+    {
+        $this->context = $context;
+    }
+
+    /**
+     * Returns the context after the subject has transitioned.
+     */
+    public function getContext(): ?array
+    {
+        return $this->context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Tests/WorkflowTest.php b/src/Symfony/Component/Workflow/Tests/WorkflowTest.php
@@ -637,7 +637,28 @@ public function testEventContext()
             $dispatcher->addListener($eventName, $assertWorkflowContext);
         }
 
-        $workflow->apply($subject, 't1', $context);
+        $marking = $workflow->apply($subject, 't1', $context);
+
+        $this->assertInstanceOf(Marking::class, $marking);
+        $this->assertSame($context, $marking->getContext());
+    }
+
+    public function testEventContextUpdated()
+    {
+        $definition = $this->createComplexWorkflowDefinition();
+        $subject = new Subject();
+        $dispatcher = new EventDispatcher();
+
+        $workflow = new Workflow($definition, new MethodMarkingStore(), $dispatcher);
+
+        $dispatcher->addListener('workflow.transition', function (TransitionEvent $event) {
+            $event->setContext(['foo' => 'bar']);
+        });
+
+        $marking = $workflow->apply($subject, 't1', ['initial']);
+
+        $this->assertInstanceOf(Marking::class, $marking);
+        $this->assertSame(['foo' => 'bar'], $marking->getContext());
     }
 
     public function testEventDefaultInitialContext()
diff --git a/src/Symfony/Component/Workflow/Workflow.php b/src/Symfony/Component/Workflow/Workflow.php
@@ -244,6 +244,8 @@ public function apply(object $subject, string $transitionName, array $context =
             $this->announce($subject, $transition, $marking, $context);
         }
 
+        $marking->setContext($context);
+
         return $marking;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -244,6 +244,8 @@ public function apply(object $subject, string $transitionName, array $context =`
`244`	`244`	`$this->announce($subject, $transition, $marking, $context);`
`245`	`245`	`}`
`246`	`246`
	`247`	`+ $marking->setContext($context);`
	`248`	`+`
`247`	`249`	`return $marking;`
`248`	`250`	`}`
`249`	`251`