Fix form mapping to uninitialized properties

symfony · ph-fritsche · Apr 19, 2020 · Apr 19, 2020 · Apr 19, 2020 · Apr 19, 2020
commit 252dffcf62f7fe6c4ceab907093ab453f6e7228c
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Form\DataMapperInterface;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
+use Symfony\Component\PropertyAccess\Exception\AccessException;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 
@@ -76,16 +77,37 @@ public function mapFormsToData($forms, &$data)
                 $propertyValue = $form->getData();
                 // If the field is of type DateTimeInterface and the data is the same skip the update to
                 // 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;
                 }
 
                 // If the data is identical to the value in $data, we are
                 // 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);
                 }
             }
         }
     }
+
+    /**
+     * Get the property value per PropertyAccessor.
+     * Treat uninitialized properties as null.
+     *
+     * @param object|array                 $objectOrArray The object or array to traverse
+     * @param string|PropertyPathInterface $propertyPath  The property path to read
+     *
+     * @return mixed The value at the end of the property path
+     *
+     * @throws Exception\InvalidArgumentException If the property path is invalid
+     * @throws Exception\UnexpectedTypeException  If a value within the path is neither object nor array
+     */
+    private function getPropertyValue($data, $propertyPath)
+    {
+        try {
+            return $this->propertyAccessor->getValue($data, $propertyPath);
+        } catch (AccessException $e) {
+            return null;
+        }
+    }
 }
@@ -17,6 +17,7 @@
 use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
 use Symfony\Component\Form\Form;
 use Symfony\Component\Form\FormConfigBuilder;
+use Symfony\Component\Form\Tests\Fixtures\TypehintedPropertiesCar;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyAccess\PropertyPath;
@@ -300,6 +301,22 @@ public function testMapFormsToDataIgnoresDisabled()
         $this->assertSame($initialEngine, $car->engine);
     }
 
+    /**
+     * @requires PHP >= 7.4
+     */
+    public function testMapFormsToUninitializedProperties()
+    {
+        $engine = new \stdClass();
+        $car = new TypehintedPropertiesCar();
+        $config = new FormConfigBuilder('engine', \stdClass::class, $this->dispatcher);
+        $config->setData($engine);
+        $form = new SubmittedForm($config);
+
+        $this->mapper->mapFormsToData([$form], $car);
+
+        $this->assertSame($engine, $car->engine);
+    }
+
     /**
      * @dataProvider provideDate
      */

@@ -0,0 +1,8 @@
+<?php
+namespace Symfony\Component\Form\Tests\Fixtures;
+
+class TypehintedPropertiesCar
+{
+    public ?\stdClass $engine;
+    public ?\stdClass $color;
+}