[Workflow] deprecate GuardEvent::getContext method

hhamon · hhamon · commit 89e5c00af77c · 2023-08-25T14:45:28.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -162,3 +162,8 @@ Validator
  * Deprecate `ValidatorBuilder::enableAnnotationMapping()`, use `ValidatorBuilder::enableAttributeMapping()` instead
  * Deprecate `ValidatorBuilder::disableAnnotationMapping()`, use `ValidatorBuilder::disableAttributeMapping()` instead
  * Deprecate `AnnotationLoader`, use `AttributeLoader` instead
+
+Workflow
+--------
+
+* Deprecate `GuardEvent::getContext` method. It will throw a `\BadMethodCallException` in 7.0
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * Add a profiler
  * Add support for multiline descriptions in PlantUML diagrams
  * Add PHP attributes to register listeners and guards
+ * Deprecate `GuardEvent::getContext` method. It will throw a `\BadMethodCallException` in 7.0
 
 6.2
 ---
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -32,6 +32,13 @@ public function __construct(object $subject, Marking $marking, Transition $trans
         $this->transitionBlockerList = new TransitionBlockerList();
     }
 
+    public function getContext(): array
+    {
+        @trigger_error(sprintf('The %s::getContext method is deprecated and will throw a \BadMethodCallException exception in next major version. You should not longer call this method as it always returns an empty array when invoked within a guard listener.', __CLASS__), \E_USER_DEPRECATED);
+
+        return parent::getContext();
+    }
+
     public function getTransition(): Transition
     {
         return parent::getTransition();

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,13 @@ public function __construct(object $subject, Marking $marking, Transition $trans`
`32`	`32`	`$this->transitionBlockerList = new TransitionBlockerList();`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ public function getContext(): array`
	`36`	`+ {`
	`37`	`+ @trigger_error(sprintf('The %s::getContext method is deprecated and will throw a \BadMethodCallException exception in next major version. You should not longer call this method as it always returns an empty array when invoked within a guard listener.', __CLASS__), \E_USER_DEPRECATED);`
	`38`	`+`
	`39`	`+ return parent::getContext();`
	`40`	`+ }`
	`41`	`+`
`35`	`42`	`public function getTransition(): Transition`
`36`	`43`	`{`
`37`	`44`	`return parent::getTransition();`