10000 Pass prototype_options to ResizeFormEventlistener, apply to new fields - Fix for issue 49786 by Thorry84 · Pull Request #36 · symfony/form · GitHub
[go: up one dir, main page]
Skip to content

Pass prototype_options to ResizeFormEventlistener, apply to new fields - Fix for issue 49786 #36

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 t 8000 o our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Pass prototype_options to ResizeFormEventlistener, apply to new fields - Fix for issue 49786 #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8097b8
Use prototype options for added fields in ResizeFormListener
Thorry84 Mar 27, 2023
00538b3
Update existing tests for new ResizeFormListener signature
Thorry84 Mar 27, 2023
d1db325
Unit test prototype_options applied to new fields CollectionType
Thorry84 Mar 27, 2023
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
12 changes: 7 additions & 5 deletions Extension/Core/EventListener/ResizeFormListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,20 @@
class ResizeFormListener implements EventSubscriberInterface
{
protected $type;
protected $options;
protected $entryOptions;
protected $prototypeOptions;
protected $allowAdd;
protected $allowDelete;

private \Closure|bool $deleteEmpty;

public function __construct(string $type, array $options = [], bool $allowAdd = false, bool $allowDelete = false, bool|callable $deleteEmpty = false)
public function __construct(string $type, array $entryOptions = [], array $prototypeOptions = [], bool $allowAdd = false, bool $allowDelete = false, bool|callable $deleteEmpty = false)
{
$this->type = $type;
$this->allowAdd = $allowAdd;
$this->allowDelete = $allowDelete;
$this->options = $options;
$this->entryOptions = $entryOptions;
$this->prototypeOptions = $prototypeOptions;
$this->deleteEmpty = \is_bool($deleteEmpty) ? $deleteEmpty : $deleteEmpty(...);
}

Expand Down Expand Up @@ -68,7 +70,7 @@ public function preSetData(FormEvent $event)
foreach ($data as $name => $value) {
$form->add($name, $this->type, array_replace([
'property_path' => '['.$name.']',
], $this->options));
], $this->entryOptions));
}
}

Expand Down Expand Up @@ -96,7 +98,7 @@ public function preSubmit(FormEvent $event)
if (!$form->has($name)) {
$form->add($name, $this->type, array_replace([
'property_path' => '['.$name.']',
], $this->options));
], $this->prototypeOptions));
}
}
}
Expand Down
1 change: 1 addition & 0 deletions Extension/Core/Type/CollectionType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
$resizeListener = new ResizeFormListener(
$options['entry_type'],
$options['entry_options'],
array_replace($options['entry_options'], $options['prototype_options']),
$options['allow_add'],
$options['allow_delete'],
$options['delete_empty']
Expand Down
36 changes: 18 additions & 18 deletions Tests/Extension/Core/EventListener/ResizeFormListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public function testPreSetDataResizesForm()

$data = [1 => 'string', 2 => 'string'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener(TextType::class, ['attr' => ['maxlength' => 10]], false, false);
$listener = new ResizeFormListener(TextType::class, ['attr' => ['maxlength' => 10]], [], false, false);
$listener->preSetData($event);

$this->assertFalse($this->form->has('0'));
Expand All @@ -72,15 +72,15 @@ public function testPreSetDataRequiresArrayOrTraversable()
$this->expectException(UnexpectedTypeException::class);
$data = 'no array or traversable';
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, false);
$listener = new ResizeFormListener('text', [], [], false, false);
$listener->preSetData($event);
}

public function testPreSetDataDealsWithNullData()
{
$data = null;
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener(TextType::class, [], false, false);
$listener = new ResizeFormListener(TextType::class, [], [], false, false);
$listener->preSetData($event);

$this->assertSame(0, $this->form->count());
Expand All @@ -92,7 +92,7 @@ public function testPreSubmitResizesUpIfAllowAdd()

$data = [0 => 'string', 1 => 'string'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener(TextType::class, ['attr' => ['maxlength' => 10]], true, false);
$listener = new ResizeFormListener(TextType::class, ['attr' => ['maxlength' => 10]], [], true, false);
$listener->preSubmit($event);

$this->assertTrue($this->form->has('0'));
Expand All @@ -106,7 +106,7 @@ public function testPreSubmitResizesDownIfAllowDelete()

$data = [0 => 'string'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->preSubmit($event);

$this->assertTrue($this->form->has('0'));
Expand All @@ -120,7 +120,7 @@ public function testPreSubmitRemovesZeroKeys()

$data = [];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->preSubmit($event);

$this->assertFalse($this->form->has('0'));
Expand All @@ -133,7 +133,7 @@ public function testPreSubmitDoesNothingIfNotAllowAddNorAllowDelete()

$data = [0 => 'string', 2 => 'string'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, false);
$listener = new ResizeFormListener('text', [], [], false, false);
$listener->preSubmit($event);

$this->assertTrue($this->form->has('0'));
Expand All @@ -145,7 +145,7 @@ public function testPreSubmitDealsWithNoArrayOrTraversable()
{
$data = 'no array or traversable';
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, false);
$listener = new ResizeFormListener('text', [], [], false, false);
$listener->preSubmit($event);

$this->assertFalse($this->form->has('1'));
Expand All @@ -157,7 +157,7 @@ public function testPreSubmitDealsWithNullData()

$data = null;
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->preSubmit($event);

$this->assertFalse($this->form->has('1'));
Expand All @@ -170,7 +170,7 @@ public function testPreSubmitDealsWithEmptyData()

$data = '';
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->preSubmit($event);

$this->assertFalse($this->form->has('1'));
Expand All @@ -182,7 +182,7 @@ public function testOnSubmitNormDataRemovesEntriesMissingInTheFormIfAllowDelete(

$data = [0 => 'first', 1 => 'second', 2 => 'third'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->onSubmit($event);

$this->assertEquals([1 => 'second'], $event->getData());
Expand All @@ -194,7 +194,7 @@ public function testOnSubmitNormDataDoesNothingIfNotAllowDelete()

$data = [0 => 'first', 1 => 'second', 2 => 'third'];
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, false);
$listener = new ResizeFormListener('text', [], [], false, false);
$listener->onSubmit($event);

$this->assertEquals($data, $event->getData());
Expand All @@ -205,7 +205,7 @@ public function testOnSubmitNormDataRequiresArrayOrTraversable()
$this->expectException(UnexpectedTypeException::class);
$data = 'no array or traversable';
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, false);
$listener = new ResizeFormListener('text', [], [], false, false);
$listener->onSubmit($event);
}

Expand All @@ -215,7 +215,7 @@ public function testOnSubmitNormDataDealsWithNullData()

$data = null;
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->onSubmit($event);

$this->assertEquals([], $event->getData());
Expand All @@ -227,7 +227,7 @@ public function testOnSubmitDealsWithObjectBackedIteratorAggregate()

$data = new \ArrayObject([0 => 'first', 1 => 'second', 2 => 'third']);
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->onSubmit($event);

$this->assertArrayNotHasKey(0, $event->getData());
Expand All @@ -240,7 +240,7 @@ public function testOnSubmitDealsWithArrayBackedIteratorAggregate()

$data = new ArrayCollection([0 => 'first', 1 => 'second', 2 => 'third']);
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true);
$listener = new ResizeFormListener('text', [], [], false, true);
$listener->onSubmit($event);

$this->assertArrayNotHasKey(0, $event->getData());
Expand All @@ -258,7 +258,7 @@ public function testOnSubmitDeleteEmptyNotCompoundEntriesIfAllowDelete()
$this->form->get($child)->submit($dat);
}
$event = new FormEvent($this->form, $data);
$listener = new ResizeFormListener('text', [], false, true, true);
$listener = new ResizeFormListener('text', [], [], false, true, true);
$listener->onSubmit($event);

$this->assertEquals([0 => 'first'], $event->getData());
Expand Down Expand Up @@ -288,7 +288,7 @@ public function testOnSubmitDeleteEmptyCompoundEntriesIfAllowDelete()
$callback = function ($data) {
return null === $data['name'];
};
$listener = new ResizeFormListener('text', [], false, true, $callback);
$listener = new ResizeFormListener('text', [], [], false, true, $callback);
$listener->onSubmit($event);

$this->assertEquals(['0' => ['name' => 'John']], $event->getData());
9E7A Expand Down
23 changes: 23 additions & 0 deletions Tests/Extension/Core/Type/CollectionTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,29 @@ public function testPrototypeOptionsOverrideEntryOptions()
$this->assertSame('foo', $form->createView()->vars['prototype']->vars['help']);
}

public function testPrototypeOptionsAppliedToNewFields()
{
$form = $this->factory->create(static::TESTED_TYPE, ['first'], [
'allow_add' => true,
'prototype' => true,
'entry_type' => TextTypeTest::TESTED_TYPE,
'entry_options' => [
'disabled' => true,
],
'prototype_options' => [
'disabled' => false,
],
]);

$form->submit(['first_changed', 'second']);

$this->assertTrue($form->has('0'));
$this->assertTrue($form->has('1'));
$this->assertSame('first', $form[0]->getData());
$this->assertSame('second', $form[1]->getData());
$this->assertSame(['first', 'second'], $form->getData());
}

public function testEntriesBlockPrefixes()
{
$collectionView = $this->factory->createNamed('fields', static::TESTED_TYPE, [''], [
Expand Down
0