Remove GuardEvent::getContext() method and add HasContextTrait trait

hhamon · hhamon · commit 16b7e82003c9 · 2023-08-26T13:38:22.000+02:00
diff --git a/UPGRADE-7.0.md b/UPGRADE-7.0.md
@@ -490,6 +490,7 @@ Workflow
 --------
 
  * Require explicit argument when calling `Definition::setInitialPlaces()`
+ * `GuardEvent::getContext()` method has been removed. Method was not supposed to be called within guard event listeners as it always returned an empty array anyway.
 
 Yaml
 ----
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -5,6 +5,8 @@ CHANGELOG
 ---
 
  * Require explicit argument when calling `Definition::setInitialPlaces()`
+ * `GuardEvent::getContext()` method has been removed. Method was not supposed to be called within guard event listeners as it always returned an empty array anyway.
+ * Add internal `HasContextTrait` trait used by all workflow event classes except by `GuardEvent` class
 
 6.4
 ---
diff --git a/src/Symfony/Component/Workflow/Event/AnnounceEvent.php b/src/Symfony/Component/Workflow/Event/AnnounceEvent.php
@@ -11,6 +11,18 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class AnnounceEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/CompletedEvent.php b/src/Symfony/Component/Workflow/Event/CompletedEvent.php
@@ -11,6 +11,18 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class CompletedEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/EnterEvent.php b/src/Symfony/Component/Workflow/Event/EnterEvent.php
@@ -11,6 +11,18 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class EnterEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/EnteredEvent.php b/src/Symfony/Component/Workflow/Event/EnteredEvent.php
@@ -11,6 +11,18 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class EnteredEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/Event.php b/src/Symfony/Component/Workflow/Event/Event.php
@@ -23,20 +23,17 @@
  */
 class Event extends BaseEvent
 {
-    protected array $context;
-
     private object $subject;
     private Marking $marking;
     private ?Transition $transition;
     private ?WorkflowInterface $workflow;
 
-    public function __construct(object $subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null, array $context = [])
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, WorkflowInterface $workflow = null)
     {
         $this->subject = $subject;
         $this->marking = $marking;
         $this->transition = $transition;
         $this->workflow = $workflow;
-        $this->context = $context;
     }
 
     public function getMarking(): Marking
@@ -68,9 +65,4 @@ public function getMetadata(string $key, string|Transition|null $subject): mixed
     {
         return $this->workflow->getMetadataStore()->getMetadata($key, $subject);
     }
-
-    public function getContext(): array
-    {
-        return $this->context;
-    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -25,7 +25,7 @@ final class GuardEvent extends Event
 {
     private TransitionBlockerList $transitionBlockerList;
 
-    public function __construct(object $subject, Marking $marking, Transition $transition, WorkflowInterface $workflow = null)
+    public function __construct(object $subject, Marking $marking, Transition $transition, ?WorkflowInterface $workflow = null)
     {
         parent::__construct($subject, $marking, $transition, $workflow);
 
diff --git a/src/Symfony/Component/Workflow/Event/HasContextTrait.php b/src/Symfony/Component/Workflow/Event/HasContextTrait.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Workflow\Event;
+
+/**
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ * @author Hugo Hamon <hugohamon@neuf.fr>
+ *
+ * @internal
+ */
+trait HasContextTrait
+{
+    private array $context = [];
+
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+}
diff --git a/src/Symfony/Component/Workflow/Event/LeaveEvent.php b/src/Symfony/Component/Workflow/Event/LeaveEvent.php
@@ -11,6 +11,18 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class LeaveEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
 }
diff --git a/src/Symfony/Component/Workflow/Event/TransitionEvent.php b/src/Symfony/Component/Workflow/Event/TransitionEvent.php
@@ -11,8 +11,21 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\Transition;
+use Symfony\Component\Workflow\WorkflowInterface;
+
 final class TransitionEvent extends Event
 {
+    use HasContextTrait;
+
+    public function __construct(object $subject, Marking $marking, ?Transition $transition = null, ?WorkflowInterface $workflow = null, array $context = [])
+    {
+        parent::__construct($subject, $marking, $transition, $workflow);
+
+        $this->context = $context;
+    }
+
     public function setContext(array $context): void
     {
         $this->context = $context;

Original file line number	Diff line number	Diff line change
`@@ -23,20 +23,17 @@`
`23`	`23`	`*/`
`24`	`24`	`class Event extends BaseEvent`
`25`	`25`	`{`
`26`		`- protected array $context;`
`27`		`-`
`28`	`26`	`private object $subject;`
`29`	`27`	`private Marking $marking;`
`30`	`28`	`private ?Transition $transition;`
`31`	`29`	`private ?WorkflowInterface $workflow;`
`32`	`30`
`33`		`- public function __construct(object $subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null, array $context = [])`
	`31`	`+ public function __construct(object $subject, Marking $marking, ?Transition $transition = null, WorkflowInterface $workflow = null)`
`34`	`32`	`{`
`35`	`33`	`$this->subject = $subject;`
`36`	`34`	`$this->marking = $marking;`
`37`	`35`	`$this->transition = $transition;`
`38`	`36`	`$this->workflow = $workflow;`
`39`		`- $this->context = $context;`
`40`	`37`	`}`
`41`	`38`
`42`	`39`	`public function getMarking(): Marking`
`@@ -68,9 +65,4 @@ public function getMetadata(string $key, string\|Transition\|null $subject): mixed`
`68`	`65`	`{`
`69`	`66`	`return $this->workflow->getMetadataStore()->getMetadata($key, $subject);`
`70`	`67`	`}`
`71`		`-`
`72`		`- public function getContext(): array`
`73`		`- {`
`74`		`- return $this->context;`
`75`		`- }`
`76`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ final class GuardEvent extends Event`
`25`	`25`	`{`
`26`	`26`	`private TransitionBlockerList $transitionBlockerList;`
`27`	`27`
`28`		`- public function __construct(object $subject, Marking $marking, Transition $transition, WorkflowInterface $workflow = null)`
	`28`	`+ public function __construct(object $subject, Marking $marking, Transition $transition, ?WorkflowInterface $workflow = null)`
`29`	`29`	`{`
`30`	`30`	`parent::__construct($subject, $marking, $transition, $workflow);`
`31`	`31`