[Workflow] Deprecate Event::getWorkflow() method

Author: lyrixx

CHANGELOG.md

@@ -1,13 +1,18 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Deprecate `Event::getWorkflow()` method
+
 7.1
 ---
 
  * Add method `getEnabledTransition()` to `WorkflowInterface`
  * Automatically register places from transitions
  * Add support for workflows that need to store many tokens in the marking
- * Add method `getName()` in event classes to build event names in subscribers 
+ * Add method `getName()` in event classes to build event names in subscribers
 
 7.0
 ---

Event/Event.php

@@ -46,8 +46,13 @@ public function getTransition(): ?Transition
         return $this->transition;
     }
 
+    /**
+     * @deprecated since Symfony 7.3, inject the workflow in the constructor where you need it
+     */
     public function getWorkflow(): WorkflowInterface
     {
+        trigger_deprecation('symfony/workflow', '7.3', 'The "%s()" method is deprecated, inject the workflow in the constructor where you need it.', __METHOD__);
+
         return $this->workflow;
     }
 

composer.json

@@ -20,15 +20,16 @@
         }
     ],
     "require": {
-        "php": ">=8.2"
+        "php": ">=8.2",
+        "symfony/deprecation-contracts": "2.5|^3"
     },
     "require-dev": {
         "psr/log": "^1|^2|^3",
         "symfony/dependency-injection": "^6.4|^7.0",
-        "symfony/event-dispatcher": "^6.4|^7.0",
         "symfony/error-handler": "^6.4|^7.0",
-        "symfony/http-kernel": "^6.4|^7.0",
+        "symfony/event-dispatcher": "^6.4|^7.0",
         "symfony/expression-language": "^6.4|^7.0",
+        "symfony/http-kernel": "^6.4|^7.0",
         "symfony/security-core": "^6.4|^7.0",
         "symfony/stopwatch": "^6.4|^7.0",
         "symfony/validator": "^6.4|^7.0"