[Workflow] Added the workflow name to all events dispatched

lyrixx · lyrixx · commit b3400c7312cc · 2017-03-08T15:21:36.000+01:00
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -7,3 +7,4 @@ CHANGELOG
  * Added `workflow.entered` events which is fired after the marking has been set.
  * Deprecated class name support in `WorkflowRegistry::add()` as second parameter.
    Wrap the class name in an instance of ClassInstanceSupportStrategy instead.
+ * Added support for `Event::getWorkflowName()`.
diff --git a/src/Symfony/Component/Workflow/Event/Event.php b/src/Symfony/Component/Workflow/Event/Event.php
@@ -24,17 +24,20 @@ class Event extends BaseEvent
     private $subject;
     private $marking;
     private $transition;
+    private $workflowName;
 
     /**
      * @param object     $subject
      * @param Marking    $marking
      * @param Transition $transition
+     * @param string     $workflowName
      */
-    public function __construct($subject, Marking $marking, Transition $transition)
+    public function __construct($subject, Marking $marking, Transition $transition, $workflowName = 'unnamed')
     {
         $this->subject = $subject;
         $this->marking = $marking;
         $this->transition = $transition;
+        $this->workflowName = $workflowName;
     }
 
     public function getMarking()
@@ -51,4 +54,9 @@ public function getTransition()
     {
         return $this->transition;
     }
+
+    public function getWorkflowName()
+    {
+        return $this->workflowName;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Workflow.php b/src/Symfony/Component/Workflow/Workflow.php
@@ -214,7 +214,7 @@ private function guardTransition($subject, Marking $marking, Transition $transit
             return;
         }
 
-        $event = new GuardEvent($subject, $marking, $transition);
+        $event = new GuardEvent($subject, $marking, $transition, $this->name);
 
         $this->dispatcher->dispatch('workflow.guard', $event);
         $this->dispatcher->dispatch(sprintf('workflow.%s.guard', $this->name), $event);
@@ -226,7 +226,7 @@ private function guardTransition($subject, Marking $marking, Transition $transit
     private function leave($subject, Transition $transition, Marking $marking)
     {
         if (null !== $this->dispatcher) {
-            $event = new Event($subject, $marking, $transition);
+            $event = new Event($subject, $marking, $transition, $this->name);
 
             $this->dispatcher->dispatch('workflow.leave', $event);
             $this->dispatcher->dispatch(sprintf('workflow.%s.leave', $this->name), $event);
@@ -247,7 +247,7 @@ private function transition($subject, Transition $transition, Marking $marking)
             return;
         }
 
-        $event = new Event($subject, $marking, $transition);
+        $event = new Event($subject, $marking, $transition, $this->name);
 
         $this->dispatcher->dispatch('workflow.transition', $event);
         $this->dispatcher->dispatch(sprintf('workflow.%s.transition', $this->name), $event);
@@ -257,7 +257,7 @@ private function transition($subject, Transition $transition, Marking $marking)
     private function enter($subject, Transition $transition, Marking $marking)
     {
         if (null !== $this->dispatcher) {
-            $event = new Event($subject, $marking, $transition);
+            $event = new Event($subject, $marking, $transition, $this->name);
 
             $this->dispatcher->dispatch('workflow.enter', $event);
             $this->dispatcher->dispatch(sprintf('workflow.%s.enter', $this->name), $event);
@@ -278,7 +278,7 @@ private function entered($subject, Transition $transition, Marking $marking)
             return;
         }
 
-        $event = new Event($subject, $marking, $transition);
+        $event = new Event($subject, $marking, $transition, $this->name);
 
         $this->dispatcher->dispatch('workflow.entered', $event);
         $this->dispatcher->dispatch(sprintf('workflow.%s.entered', $this->name), $event);

Original file line number	Diff line number	Diff line change
`@@ -24,17 +24,20 @@ class Event extends BaseEvent`
`24`	`24`	`private $subject;`
`25`	`25`	`private $marking;`
`26`	`26`	`private $transition;`
	`27`	`+ private $workflowName;`
`27`	`28`
`28`	`29`	`/**`
`29`	`30`	`* @param object $subject`
`30`	`31`	`* @param Marking $marking`
`31`	`32`	`* @param Transition $transition`
	`33`	`+ * @param string $workflowName`
`32`	`34`	`*/`
`33`		`- public function __construct($subject, Marking $marking, Transition $transition)`
	`35`	`+ public function __construct($subject, Marking $marking, Transition $transition, $workflowName = 'unnamed')`
`34`	`36`	`{`
`35`	`37`	`$this->subject = $subject;`
`36`	`38`	`$this->marking = $marking;`
`37`	`39`	`$this->transition = $transition;`
	`40`	`+ $this->workflowName = $workflowName;`
`38`	`41`	`}`
`39`	`42`
`40`	`43`	`public function getMarking()`
`@@ -51,4 +54,9 @@ public function getTransition()`
`51`	`54`	`{`
`52`	`55`	`return $this->transition;`
`53`	`56`	`}`
	`57`	`+`
	`58`	`+ public function getWorkflowName()`
	`59`	`+ {`
	`60`	`+ return $this->workflowName;`
	`61`	`+ }`
`54`	`62`	`}`