8000 [Form][2.2] Fixed Form::submit() to react to dynamic form modifications by webmozart · Pull Request #8827 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[Form][2.2] Fixed Form::submit() to react to dynamic form modifications #8827

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.

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 4 commits into from
Aug 23, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,24 @@ public function __construct(PropertyAccessorInterface $propertyAccessor = null)
*/
public function mapDataToForms($data, array $forms)
{
if (null === $data || array() === $data) {
return;
}
$empty = null === $data || array() === $data;

if (!is_array($data) && !is_object($data)) {
if (!$empty && !is_array($data) && !is_object($data)) {
throw new UnexpectedTypeException($data, 'object, array or empty');
}

$iterator = new VirtualFormAwareIterator($forms);
$iterator = new \RecursiveIteratorIterator($iterator);

foreach ($iterator as $form) {
/* @var FormInterface $form */
/* @var \Symfony\Component\Form\FormInterface $form */
$propertyPath = $form->getPropertyPath();
$config = $form->getConfig();

if (null !== $propertyPath && $config->getMapped()) {
if (!$empty && null !== $propertyPath && $config->getMapped()) {
$form->setData($this->propertyAccessor->getValue($data, $propertyPath));
} else {
$form->setData($form->getConfig()->getData());
}
}
}
Expand All @@ -83,7 +83,7 @@ public function mapFormsToData(array $forms, &$data)
$iterator = new \RecursiveIteratorIterator($iterator);

foreach ($iterator as $form) {
/* @var FormInterface $form */
/* @var \Symfony\Component\Form\FormInterface $form */
$propertyPath = $form->getPropertyPath();
$config = $form->getConfig();

Expand Down
7 changes: 5 additions & 2 deletions src/Symfony/Component/Form/Form.php
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,10 @@ public function bind($submittedData)
$submittedData = array();
}

foreach ($this->children as $name => $child) {
for (reset($this->children); false !== current($this->children); next($this->children)) {
$child = current($this->children);
$name = key($this->children);

$child->bind(isset($submittedData[$name]) ? $submittedData[$name] : null);
unset($submittedData[$name]);
}
Expand Down Expand Up @@ -829,7 +832,7 @@ public function getClientTransformers()
/**
* {@inheritdoc}
*/
public function all()
public function &all()
{
return $this->children;
}
Expand Down
3 changes: 3 additions & 0 deletions src/Symfony/Component/Form/Tests/AbstractFormTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ protected function getMockForm($name = 'name')
$form->expects($this->any())
->method('getName')
->will($this->returnValue($name));
$form->expects($this->any())
->method('getConfig')
->will($this->returnValue($this->getMock('Symfony\Component\Form\FormConfigInterface')));

return $form;
}
Expand Down
55 changes: 41 additions & 14 deletions src/Symfony/Component/Form/Tests/CompoundFormTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@

namespace Symfony\Component\Form\Tests;

use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormError;
use Symfony\Component\Form\Extension\HttpFoundation\EventListener\BindRequestListener;
use Symfony\Component\HttpFoundation\Request;
Expand Down Expand Up @@ -46,19 +45,6 @@ public function testInvalidIfChildIsInvalid()
$this->assertFalse($this->form->isValid());
}

public function testBindForwardsNullIfValueIsMissing()
{
$child = $this->getMockForm('firstName');

$this->form->add($child);

$child->expects($this->once())
->method('bind')
->with($this->equalTo(null));

$this->form->bind(array());
}

public function testCloneChildren()
{
$child = $this->getBuilder('child')->getForm();
Expand Down Expand Up @@ -322,6 +308,47 @@ public function testSetDataMapsViewDataToChildren()
$form->setData('foo');
}

public function testBindForwardsNullIfValueIsMissing()
{
$child = $this->getMockForm('firstName');

$this->form->add($child);

$child->expects($this->once())
->method('bind')
->with($this->equalTo(null));

$this->form->bind(array());
}

public function testBindSupportsDynamicAdditionAndRemovalOfChildren()
{
$child = $this->getMockForm('child');
$childToBeRemoved = $this->getMockForm('removed');
$childToBeAdded = $this->getMockForm('added');

$this->form->add($child);
$this->form->add($childToBeRemoved);

$form = $this->form;

$child->expects($this->once())
->method('bind')
->will($this->returnCallback(function () use ($form, $childToBeAdded) {
$form->remove('removed');
$form->add($childToBeAdded);
}));

$childToBeRemoved->expects($this->never())
->method('bind');

$childToBeAdded->expects($this->once())
->method('bind');

// pass NULL to all children
$this->form->bind(array());
}

public function testBindMapsBoundChildrenOntoExistingViewData()
{
$test = $this;
Expand Down
9E81
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,9 @@ public function testMapDataToFormsIgnoresUnmapped()
$this->assertNull($form->getData());
}

public function testMapDataToFormsIgnoresEmptyData()
public function testMapDataToFormsSetsDefaultDataIfPassedDataIsNull()
{
$default = new \stdClass();
$propertyPath = $this->getPropertyPath('engine');

$this->propertyAccessor->expects($this->never())
Expand All @@ -175,11 +176,43 @@ public function testMapDataToFormsIgnoresEmptyData()
$config = new FormConfigBuilder('name', '\stdClass', $this->dispatcher);
$config->setByReference(true);
$config->setPropertyPath($propertyPath);
$form = $this->getForm($config);
$config->setData($default);

$form = $this->getMockBuilder('Symfony\Component\Form\Form')
->setConstructorArgs(array($config))
->setMethods(array('setData'))
->getMock();

$form->expects($this->once())
->method('setData')
->with($default);

$this->mapper->mapDataToForms(null, array($form));
}

$this->assertNull($form->getData());
public function testMapDataToFormsSetsDefaultDataIfPassedDataIsEmptyArray()
{
$default = new \stdClass();
$propertyPath = $this->getPropertyPath('engine');

$this->propertyAccessor->expects($this->never())
->method('getValue');

$config = new FormConfigBuilder('name', '\stdClass', $this->dispatcher);
$config->setByReference(true);
$config->setPropertyPath($propertyPath);
$config->setData($default);

$form = $this->getMockBuilder('Symfony\Component\Form\Form')
->setConstructorArgs(array($config))
->setMethods(array('setData'))
->getMock();

$form->expects($this->once())
->method('setData')
->with($default);

$this->mapper->mapDataToForms(array(), array($form));
}

public function testMapDataToFormsSkipsVirtualForms()
Expand Down
122 changes: 122 additions & 0 deletions src/Symfony/Component/Form/Tests/Util/VirtualFormAwareIteratorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Form\Tests\Util;

use Symfony\Component\Form\Util\VirtualFormAwareIterator;

/**
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class VirtualFormAwareIteratorTest extends \PHPUnit_Framework_TestCase
{
public function testSupportDynamicModification()
{
$form = $this->getMockForm('form');
$formToBeAdded = $this->getMockForm('added');
$formToBeRemoved = $this->getMockForm('removed');

$forms = array('form' => $form, 'removed' => $formToBeRemoved);
$iterator = new VirtualFormAwareIterator($forms);

$iterator->rewind();
$this->assertTrue($iterator->valid());
$this->assertSame('form', $iterator->key());
$this->assertSame($form, $iterator->current());

// dynamic modification
unset($forms['removed']);
$forms['added'] = $formToBeAdded;

// continue iteration
$iterator->next();
$this->assertTrue($iterator->valid());
$this->assertSame('added', $iterator->key());
$this->assertSame($formToBeAdded, $iterator->current());

// end of array
$iterator->next();
$this->assertFalse($iterator->valid());
}

public function testSupportDynamicModificationInRecursiveCall()
{
$virtualForm = $this->getMockForm('virtual');
$form = $this->getMockForm('form');
$formToBeAdded = $this->getMockForm('added');
$formToBeRemoved = $this->getMockForm('removed');

$virtualForm->getConfig()->expects($this->any())
->method('getVirtual')
->will($this->returnValue(true));

$virtualForm->add($form);
$virtualForm->add($formToBeRemoved);

$forms = array('virtual' => $virtualForm);
$iterator = new VirtualFormAwareIterator($forms);

$iterator->rewind();
$this->assertTrue($iterator->valid());
$this->assertSame('virtual', $iterator->key());
$this->assertSame($virtualForm, $iterator->current());
$this->assertTrue($iterator->hasChildren());

// enter nested iterator
$nestedIterator = $iterator->getChildren();
$this->assertSame('form', $nestedIterator->key());
$this->assertSame($form, $nestedIterator->current());
$this->assertFalse($nestedIterator->hasChildren());

// dynamic modification
$virtualForm->remove('removed');
$virtualForm->add($formToBeAdded);

// continue iteration - nested iterator discovers change in the form
$nestedIterator->next();
$this->assertTrue($nestedIterator->valid());
$this->assertSame('added', $nestedIterator->key());
$this->assertSame($formToBeAdded, $nestedIterator->current());

// end of array
$nestedIterator->next();
$this->assertFalse($nestedIterator->valid());
}

/**
* @param string $name
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
protected function getMockForm($name = 'name')
{
$config = $this->getMock('Symfony\Component\Form\FormConfigInterface');

$config->expects($this->any())
->method('getName')
->will($this->returnValue($name));
$config->expects($this->any())
->method('getCompound')
->will($this->returnValue(true));
$config->expects($this->any())
->method('getDataMapper')
->will($this->returnValue($this->getMock('Symfony\Component\Form\DataMapperInterface')));
$config->expects($this->any())
->method('getEventDispatcher')
->will($this->returnValue($this->getMock('Symfony\Component\EventDispatcher\EventDispatcher')));

return $this->getMockBuilder('Symfony\Component\Form\Form')
->setConstructorArgs(array($config))
->disableArgumentCloning()
->setMethods(array('getViewData'))
->getMock();
}
}
Loading
0