feature #51043 [Form] Deprecate FormEvent::setData() for events that do not allow it (HeahDude)

nicolas-grekas · nicolas-grekas · commit 503a7b3cb62f · 2023-07-21T11:43:18.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Form] Deprecate `FormEvent::setData()` for events that do not allow it | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | yes | Tickets | ~ | License | MIT | Doc PR | TODO Now that specific classes exist for each event, we can improve DX by forbidding to call `FormEvent::setData()` where it does not make sense. Commits ------- 0d318d0 [Form] Deprecate `FormEvent::setData()` for events that do not allow it
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -29,6 +29,8 @@ Form
 
  * Deprecate using `DateTime` or `DateTimeImmutable` model data with a different timezone than configured with the
    `model_timezone` option in `DateType`, `DateTimeType`, and `TimeType`
+ * Deprecate `PostSetDataEvent::setData()`, use `PreSetDataEvent::setData()` instead
+ * Deprecate `PostSubmitEvent::setData()`, use `PreSubmitDataEvent::setData()` or `SubmitDataEvent::setData()` instead
 
 FrameworkBundle
 ---------------
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -6,6 +6,8 @@ CHANGELOG
 
  * Deprecate using `DateTime` or `DateTimeImmutable` model data with a different timezone than configured with the
    `model_timezone` option in `DateType`, `DateTimeType`, and `TimeType`
+ * Deprecate `PostSetDataEvent::setData()`, use `PreSetDataEvent::setData()` instead
+ * Deprecate `PostSubmitEvent::setData()`, use `PreSubmitDataEvent::setData()` or `SubmitDataEvent::setData()` instead
 
 6.3
 ---
diff --git a/src/Symfony/Component/Form/Event/PostSetDataEvent.php b/src/Symfony/Component/Form/Event/PostSetDataEvent.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Form\Event;
 
+use Symfony\Component\Form\Exception\BadMethodCallException;
 use Symfony\Component\Form\FormEvent;
 
 /**
@@ -20,4 +21,12 @@
  */
 final class PostSetDataEvent extends FormEvent
 {
+    /**
+     * @deprecated since Symfony 6.4, it will throw an exception in 7.0.
+     */
+    public function setData(mixed $data): void
+    {
+        trigger_deprecation('symfony/form', '6.4', 'Calling "%s()" will throw an exception as of 7.0, listen to "form.pre_set_data" instead.', __METHOD__);
+        // throw new BadMethodCallException('Form data cannot be changed during "form.post_set_data", you should use "form.pre_set_data" instead.');
+    }
 }
diff --git a/src/Symfony/Component/Form/Event/PostSubmitEvent.php b/src/Symfony/Component/Form/Event/PostSubmitEvent.php
@@ -21,4 +21,12 @@
  */
 final class PostSubmitEvent extends FormEvent
 {
+    /**
+     * @deprecated since Symfony 6.4, it will throw an exception in 7.0.
+     */
+    public function setData(mixed $data): void
+    {
+        trigger_deprecation('symfony/form', '6.4', 'Calling "%s()" will throw an exception as of 7.0, listen to "form.pre_submit" or "form.submit" instead.', __METHOD__);
+        // throw new BadMethodCallException('Form data cannot be changed during "form.post_submit", you should use "form.pre_submit" or "form.submit" instead.');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,12 @@`
`21`	`21`	`*/`
`22`	`22`	`final class PostSubmitEvent extends FormEvent`
`23`	`23`	`{`
	`24`	`+ /**`
	`25`	`+ * @deprecated since Symfony 6.4, it will throw an exception in 7.0.`
	`26`	`+ */`
	`27`	`+ public function setData(mixed $data): void`
	`28`	`+ {`
	`29`	`+ trigger_deprecation('symfony/form', '6.4', 'Calling "%s()" will throw an exception as of 7.0, listen to "form.pre_submit" or "form.submit" instead.', __METHOD__);`
	`30`	`+ // throw new BadMethodCallException('Form data cannot be changed during "form.post_submit", you should use "form.pre_submit" or "form.submit" instead.');`
	`31`	`+ }`
`24`	`32`	`}`