Skip to content

[Form] Remove BC layer from ResizeFormListener #60952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2025
+8 −109
Merged

[Form] Remove BC layer from ResizeFormListener #60952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions UPGRADE-8.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ Form

* Made `ResizeFormListener::postSetData()` method `final`
* Remove the `VersionAwareTest` trait, use feature detection instead
* Remove deprecated `ResizeFormListener::preSetData()` method, use `postSetData()` instead

FrameworkBundle
---------------
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Form/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Change default value of `default_protocol` option in `UrlType` from `'http'` to `null`
* Remove the `VersionAwareTest` trait, use feature detection instead
* Remove deprecated `ResizeFormListener::preSetData()` method, use `postSetData()` instead

7.4
---
Expand Down
45 changes: 3 additions & 42 deletions src/Symfony/Component/Form/Extension/Core/EventListener/ResizeFormListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ class ResizeFormListener implements EventSubscriberInterface
protected array $prototypeOptions;

private \Closure|bool $deleteEmpty;
// BC, to be removed in 8.0
private bool $overridden = true;
private bool $usePreSetData = false;

public function __construct(
private string $type,
Expand All @@ -48,7 +45,6 @@ public function __construct(
public static function getSubscribedEvents(): array
{
return [
FormEvents::PRE_SET_DATA => 'preSetData', // deprecated
FormEvents::POST_SET_DATA => ['postSetData', 255], // as early as possible
FormEvents::PRE_SUBMIT => 'preSubmit',
// (MergeCollectionListener, MergeDoctrineCollectionListener)
Expand All @@ -57,46 +53,11 @@ public static function getSubscribedEvents(): array
}

/**
* @deprecated Since Symfony 7.2, use {@see postSetData()} instead.
*
* @final since Symfony 7.2
*/
public function preSetData(FormEvent $event): void
public function postSetData(PostSetDataEvent $event): void
{
if (__CLASS__ === static::class
|| __CLASS__ === (new \ReflectionClass($this))->getMethod('preSetData')->getDeclaringClass()->name
) {
// not a child class, or child class does not overload PRE_SET_DATA
return;
}

trigger_deprecation('symfony/form', '7.2', 'Calling "%s()" is deprecated, use "%s::postSetData()" instead.', __METHOD__, __CLASS__);
// parent::preSetData() has been called
$this->overridden = false;
try {
$this->postSetData($event);
} finally {
$this->usePreSetData = true;
}
}

/**
* Remove FormEvent type hint in 8.0.
*/
final public function postSetData(FormEvent|PostSetDataEvent $event): void
{
if (__CLASS__ !== static::class) {
if ($this->overridden) {
trigger_deprecation('symfony/form', '7.2', 'Calling "%s::preSetData()" is deprecated, use "%s::postSetData()" instead.', static::class, __CLASS__);
// parent::preSetData() has not been called, noop

return;
}

if ($this->usePreSetData) {
// nothing else to do
return;
}
}

$form = $event->getForm();
$data = $event->getData() ?? [];

Expand Down
69 changes: 3 additions & 66 deletions src/Symfony/Component/Form/Tests/Extension/Core/EventListener/ResizeFormListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Event\PostSetDataEvent;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormFactoryBuilder;
use Symfony\Component\Form\FormFactoryInterface;
Expand All @@ -43,35 +44,6 @@ protected function getBuilder($name = 'name')
return new FormBuilder($name, null, new EventDispatcher(), $this->factory);
}

/**
* @group legacy
*/
public function testPreSetDataResizesForm()
{
$this->builder->add($this->getBuilder('0'));
$this->builder->add($this->getBuilder('1'));
$this->builder->addEventSubscriber(new class(TextType::class, ['attr' => ['maxlength' => 10]], false, false) extends ResizeFormListener {
public function preSetData(FormEvent $event): void
{
parent::preSetData($event);
}
});

$form = $this->builder->getForm();

$this->assertTrue($form->has('0'));

// initialize the form
$form->setData([1 => 'string', 2 => 'string']);

$this->assertFalse($form->has('0'));
$this->assertTrue($form->has('1'));
$this->assertTrue($form->has('2'));

$this->assertSame('string', $form->get('1')->getData());
$this->assertSame('string', $form->get('2')->getData());
}

public function testPostSetDataResizesForm()
{
$this->builder->add($this->getBuilder('0'));
Expand All @@ -93,54 +65,19 @@ public function testPostSetDataResizesForm()
$this->assertSame('string', $form->get('2')->getData());
}

/**
* @group legacy
*/
public function testPreSetDataRequiresArrayOrTraversable()
{
$this->expectException(UnexpectedTypeException::class);
$data = 'no array or traversable';
$event = new FormEvent($this->builder->getForm(), $data);
$listener = new class(TextType::class, [], false, false) extends ResizeFormListener {
public function preSetData(FormEvent $event): void
{
parent::preSetData($event);
}
};
$listener->preSetData($event);
}

public function testPostSetDataRequiresArrayOrTraversable()
{
$this->expectException(UnexpectedTypeException::class);
$data = 'no array or traversable';
$event = new FormEvent($this->builder->getForm(), $data);
$event = new PostSetDataEvent($this->builder->getForm(), $data);
$listener = new ResizeFormListener(TextType::class, [], false, false);
$listener->postSetData($event);
}

/**
* @group legacy
*/
public function testPreSetDataDealsWithNullData()
{
$data = null;
$event = new FormEvent($this->builder->getForm(), $data);
$listener = new class(TextType::class, [], false, false) extends ResizeFormListener {
public function preSetData(FormEvent $event): void
{
parent::preSetData($event);
}
};
$listener->preSetData($event);

$this->assertSame(0, $this->builder->count());
}

public function testPostSetDataDealsWithNullData()
{
$data = null;
$event = new FormEvent($this->builder->getForm(), $data);
$event = new PostSetDataEvent($this->builder->getForm(), $data);
$listener = new ResizeFormListener(TextType::class, [], false, false);
$listener->postSetData($event);

Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/Form/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
],
"require": {
"php": ">=8.4",
"symfony/deprecation-contracts": "^2.5|^3",
"symfony/event-dispatcher": "^7.4|^8.0",
"symfony/options-resolver": "^7.4|^8.0",
"symfony/polyfill-ctype": "^1.8",
Expand Down
Loading