[Workflow] Trigger entered event for subject entering in the Workfl…

…ow for the first time
kagje · Nov 8, 2018 · 388840f · 388840f
1 parent 8d277ce
commit 388840f
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * Trigger `entered` event for subject entering in the Workflow for the first time
+
 4.1.0
 -----
 

diff --git a/src/Symfony/Component/Workflow/Event/Event.php b/src/Symfony/Component/Workflow/Event/Event.php
@@ -35,7 +35,7 @@ class Event extends BaseEvent
      * @param Transition        $transition
      * @param WorkflowInterface $workflow
      */
-    public function __construct($subject, Marking $marking, Transition $transition, $workflow = null)
+    public function __construct($subject, Marking $marking, Transition $transition = null, $workflow = null)
     {
         $this->subject = $subject;
         $this->marking = $marking;

diff --git a/src/Symfony/Component/Workflow/Tests/WorkflowTest.php b/src/Symfony/Component/Workflow/Tests/WorkflowTest.php
@@ -373,6 +373,8 @@ public function testApplyWithEventDispatcher()
         $workflow = new Workflow($definition, new MultipleStateMarkingStore(), $eventDispatcher, 'workflow_name');
 
         $eventNameExpected = array(
+            'workflow.entered',
+            'workflow.workflow_name.entered',
             'workflow.guard',
             'workflow.workflow_name.guard',
             'workflow.workflow_name.guard.t1',

diff --git a/src/Symfony/Component/Workflow/Workflow.php b/src/Symfony/Component/Workflow/Workflow.php
@@ -61,6 +61,8 @@ public function getMarking($subject)
 
             // update the subject with the new marking
             $this->markingStore->setMarking($subject, $marking);
+
+            $this->entered($subject, null, $marking);
         }
 
         // check that the subject has a known place
@@ -323,7 +325,7 @@ private function enter($subject, Transition $transition, Marking $marking): void
         }
     }
 
-    private function entered($subject, Transition $transition, Marking $marking): void
+    private function entered($subject, Transition $transition = null, Marking $marking): void
     {
         if (null === $this->dispatcher) {
             return;
@@ -334,8 +336,10 @@ private function entered($subject, Transition $transition, Marking $marking): vo
         $this->dispatcher->dispatch('workflow.entered', $event);
         $this->dispatcher->dispatch(sprintf('workflow.%s.entered', $this->name), $event);
 
-        foreach ($transition->getTos() as $place) {
-            $this->dispatcher->dispatch(sprintf('workflow.%s.entered.%s', $this->name, $place), $event);
+        if ($transition) {
+            foreach ($transition->getTos() as $place) {
+                $this->dispatcher->dispatch(sprintf('workflow.%s.entered.%s', $this->name, $place), $event);
+            }
         }
     }