feature #29145 [Workflow] Trigger entered event for subject entering in the Workflow for the first time (lyrixx)

nicolas-grekas · nicolas-grekas · commit 905119b752c9 · 2018-12-01T09:56:47.000+01:00
This PR was merged into the 4.3-dev branch. Discussion ---------- [Workflow] Trigger `entered` event for subject entering in the Workflow for the first time | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #28319 | License | MIT | Doc PR | Commits ------- 388840f [Workflow] Trigger `entered` event for subject entering in the Workflow for the first time
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
@@ -399,6 +399,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
@@ -331,7 +333,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;
@@ -342,8 +344,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);
+            }
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class Event extends BaseEvent`
`35`	`35`	`* @param Transition $transition`
`36`	`36`	`* @param WorkflowInterface $workflow`
`37`	`37`	`*/`
`38`		`- public function __construct($subject, Marking $marking, Transition $transition, $workflow = null)`
	`38`	`+ public function __construct($subject, Marking $marking, Transition $transition = null, $workflow = null)`
`39`	`39`	`{`
`40`	`40`	`$this->subject = $subject;`
`41`	`41`	`$this->marking = $marking;`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,8 @@ public function getMarking($subject)`
`61`	`61`
`62`	`62`	`// update the subject with the new marking`
`63`	`63`	`$this->markingStore->setMarking($subject, $marking);`
	`64`	`+`
	`65`	`+ $this->entered($subject, null, $marking);`
`64`	`66`	`}`
`65`	`67`
`66`	`68`	`// check that the subject has a known place`
`@@ -331,7 +333,7 @@ private function enter($subject, Transition $transition, Marking $marking): void`
`331`	`333`	`}`
`332`	`334`	`}`
`333`	`335`
`334`		`- private function entered($subject, Transition $transition, Marking $marking): void`
	`336`	`+ private function entered($subject, Transition $transition = null, Marking $marking): void`
`335`	`337`	`{`
`336`	`338`	`if (null === $this->dispatcher) {`
`337`	`339`	`return;`
`@@ -342,8 +344,10 @@ private function entered($subject, Transition $transition, Marking $marking): vo`
`342`	`344`	`$this->dispatcher->dispatch('workflow.entered', $event);`
`343`	`345`	`$this->dispatcher->dispatch(sprintf('workflow.%s.entered', $this->name), $event);`
`344`	`346`
`345`		`- foreach ($transition->getTos() as $place) {`
`346`		`- $this->dispatcher->dispatch(sprintf('workflow.%s.entered.%s', $this->name, $place), $event);`
	`347`	`+ if ($transition) {`
	`348`	`+ foreach ($transition->getTos() as $place) {`
	`349`	`+ $this->dispatcher->dispatch(sprintf('workflow.%s.entered.%s', $this->name, $place), $event);`
	`350`	`+ }`
`347`	`351`	`}`
`348`	`352`	`}`
`349`	`353`