bug #37520 [Form] silently ignore uninitialized properties when mapping data to forms (ph-fritsche)
This PR was merged into the 3.4 branch.
Discussion
----------
[Form] silently ignore uninitialized properties when mapping data to forms
| Q | A
| ------------- | ---
| Branch? | 3.4
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | #36492
| License | MIT
| Doc PR |
Commits
-------
b4616c810c
silently ignore uninitialized properties when mapping data to forms
This commit is contained in:
commit
6bfdb92736
@ -13,6 +13,8 @@ namespace Symfony\Component\Form\Extension\Core\DataMapper;
|
|||||||
|
|
||||||
use Symfony\Component\Form\DataMapperInterface;
|
use Symfony\Component\Form\DataMapperInterface;
|
||||||
use Symfony\Component\Form\Exception\UnexpectedTypeException;
|
use Symfony\Component\Form\Exception\UnexpectedTypeException;
|
||||||
|
use Symfony\Component\PropertyAccess\Exception\AccessException;
|
||||||
|
use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
|
||||||
use Symfony\Component\PropertyAccess\PropertyAccess;
|
use Symfony\Component\PropertyAccess\PropertyAccess;
|
||||||
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
|
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
|
||||||
|
|
||||||
@ -46,7 +48,7 @@ class PropertyPathMapper implements DataMapperInterface
|
|||||||
$config = $form->getConfig();
|
$config = $form->getConfig();
|
||||||
|
|
||||||
if (!$empty && null !== $propertyPath && $config->getMapped()) {
|
if (!$empty && null !== $propertyPath && $config->getMapped()) {
|
||||||
$form->setData($this->propertyAccessor->getValue($data, $propertyPath));
|
$form->setData($this->getPropertyValue($data, $propertyPath));
|
||||||
} else {
|
} else {
|
||||||
$form->setData($config->getData());
|
$form->setData($config->getData());
|
||||||
}
|
}
|
||||||
@ -76,16 +78,32 @@ class PropertyPathMapper implements DataMapperInterface
|
|||||||
$propertyValue = $form->getData();
|
$propertyValue = $form->getData();
|
||||||
// If the field is of type DateTimeInterface and the data is the same skip the update to
|
// If the field is of type DateTimeInterface and the data is the same skip the update to
|
||||||
// keep the original object hash
|
// keep the original object hash
|
||||||
if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->propertyAccessor->getValue($data, $propertyPath)) {
|
if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->getPropertyValue($data, $propertyPath)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the data is identical to the value in $data, we are
|
// If the data is identical to the value in $data, we are
|
||||||
// dealing with a reference
|
// dealing with a reference
|
||||||
if (!\is_object($data) || !$config->getByReference() || $propertyValue !== $this->propertyAccessor->getValue($data, $propertyPath)) {
|
if (!\is_object($data) || !$config->getByReference() || $propertyValue !== $this->getPropertyValue($data, $propertyPath)) {
|
||||||
$this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
|
$this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function getPropertyValue($data, $propertyPath)
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
return $this->propertyAccessor->getValue($data, $propertyPath);
|
||||||
|
} catch (AccessException $e) {
|
||||||
|
if (!$e instanceof UninitializedPropertyException
|
||||||
|
// For versions without UninitializedPropertyException check the exception message
|
||||||
|
&& (class_exists(UninitializedPropertyException::class) || false === strpos($e->getMessage(), 'You should initialize it'))
|
||||||
|
) {
|
||||||
|
throw $e;
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -17,6 +17,7 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
|
|||||||
use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
|
use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
|
||||||
use Symfony\Component\Form\Form;
|
use Symfony\Component\Form\Form;
|
||||||
use Symfony\Component\Form\FormConfigBuilder;
|
use Symfony\Component\Form\FormConfigBuilder;
|
||||||
|
use Symfony\Component\Form\Tests\Fixtures\TypehintedPropertiesCar;
|
||||||
use Symfony\Component\PropertyAccess\PropertyAccess;
|
use Symfony\Component\PropertyAccess\PropertyAccess;
|
||||||
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
|
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
|
||||||
use Symfony\Component\PropertyAccess\PropertyPath;
|
use Symfony\Component\PropertyAccess\PropertyPath;
|
||||||
@ -113,6 +114,23 @@ class PropertyPathMapperTest extends TestCase
|
|||||||
$this->assertNull($form->getData());
|
$this->assertNull($form->getData());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @requires PHP 7.4
|
||||||
|
*/
|
||||||
|
public function testMapDataToFormsIgnoresUninitializedProperties()
|
||||||
|
{
|
||||||
|
$engineForm = new Form(new FormConfigBuilder('engine', null, $this->dispatcher));
|
||||||
|
$colorForm = new Form(new FormConfigBuilder('color', null, $this->dispatcher));
|
||||||
|
|
||||||
|
$car = new TypehintedPropertiesCar();
|
||||||
|
$car->engine = 'BMW';
|
||||||
|
|
||||||
|
$this->mapper->mapDataToForms($car, [$engineForm, $colorForm]);
|
||||||
|
|
||||||
|
$this->assertSame($car->engine, $engineForm->getData());
|
||||||
|
$this->assertNull($colorForm->getData());
|
||||||
|
}
|
||||||
|
|
||||||
public function testMapDataToFormsSetsDefaultDataIfPassedDataIsNull()
|
public function testMapDataToFormsSetsDefaultDataIfPassedDataIsNull()
|
||||||
{
|
{
|
||||||
$default = new \stdClass();
|
$default = new \stdClass();
|
||||||
@ -293,13 +311,28 @@ class PropertyPathMapperTest extends TestCase
|
|||||||
$config->setPropertyPath($propertyPath);
|
$config->setPropertyPath($propertyPath);
|
||||||
$config->setData($engine);
|
$config->setData($engine);
|
||||||
$config->setDisabled(true);
|
$config->setDisabled(true);
|
||||||
$form = new Form($config);
|
$form = new SubmittedForm($config);
|
||||||
|
|
||||||
$this->mapper->mapFormsToData([$form], $car);
|
$this->mapper->mapFormsToData([$form], $car);
|
||||||
|
|
||||||
$this->assertSame($initialEngine, $car->engine);
|
$this->assertSame($initialEngine, $car->engine);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @requires PHP 7.4
|
||||||
|
*/
|
||||||
|
public function testMapFormsToUninitializedProperties()
|
||||||
|
{
|
||||||
|
$car = new TypehintedPropertiesCar();
|
||||||
|
$config = new FormConfigBuilder('engine', null, $this->dispatcher);
|
||||||
|
$config->setData('BMW');
|
||||||
|
$form = new SubmittedForm($config);
|
||||||
|
|
||||||
|
$this->mapper->mapFormsToData([$form], $car);
|
||||||
|
|
||||||
|
$this->assertSame('BMW', $car->engine);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @dataProvider provideDate
|
* @dataProvider provideDate
|
||||||
*/
|
*/
|
||||||
@ -339,7 +372,7 @@ class SubmittedForm extends Form
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class NotSynchronizedForm extends Form
|
class NotSynchronizedForm extends SubmittedForm
|
||||||
{
|
{
|
||||||
public function isSynchronized()
|
public function isSynchronized()
|
||||||
{
|
{
|
||||||
|
@ -0,0 +1,18 @@
|
|||||||
|
<?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\Fixtures;
|
||||||
|
|
||||||
|
class TypehintedPropertiesCar
|
||||||
|
{
|
||||||
|
public ?string $engine;
|
||||||
|
public ?string $color;
|
||||||
|
}
|
Reference in New Issue
Block a user