feature #50295 [PropertyAccess] Auto-cast from/to DateTime/Immutable when appropriate (nicolas-grekas)

fabpot · fabpot · commit e868f0a0108e · 2023-07-13T12:19:55.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [PropertyAccess] Auto-cast from/to DateTime/Immutable when appropriate | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Best reviewed [ignoring whitespaces](https://github.com/symfony/symfony/pull/50295/files?w=1). My starting point is a form with a date defined as such: ```php class MyFormType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options): void { $builder ->add('some_date', DateTimeType::class) ; } // ... } class MyEntity { private ?\DateTimeImmutable $someDate = null; //... } ``` Then doing something like: ```php $myEntity = new MyEntity(); $form = $this->createForm(MyFormType::class, $myEntity); ``` If I submit this form, I get: ``` Expected argument of type "DateTimeImmutable", "DateTime" given at property path "some_date". ``` The current solution is to set option `input` to `datetime_immutable` in `buildForm()`. But this is boring. Too much boilerplate. I've tried looking at the Form component to define the `input` option based on the entity provided when building the form, but this entity is not passed to sub-forms, so that we have no way to do this. The only way I found is the one attached: if we cannot set a `DateTime`, we try setting a `DateTimeImmutable`. I thought about changing the default value of option `input` to `datetime_immutable`, but this would need a nasty deprecation that'd force everybody to write even more boilerplate before v7, while what we want is less. So here we are. Commits ------- 3156a60 [PropertyAccess] Auto-cast from/to DateTime/Immutable when appropriate
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -514,7 +514,7 @@ private function writeIndex(array $zval, string|int $index, mixed $value): void
      *
      * @throws NoSuchPropertyException if the property does not exist or is not public
      */
-    private function writeProperty(array $zval, string $property, mixed $value): void
+    private function writeProperty(array $zval, string $property, mixed $value, bool $recursive = false): void
     {
         if (!\is_object($zval[self::VALUE])) {
             throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%1$s]" instead?', $property));
@@ -524,24 +524,37 @@ private function writeProperty(array $zval, string $property, mixed $value): voi
         $class = $object::class;
         $mutator = $this->getWriteInfo($class, $property, $value);
 
-        if (PropertyWriteInfo::TYPE_NONE !== $mutator->getType()) {
-            $type = $mutator->getType();
+        try {
+            if (PropertyWriteInfo::TYPE_NONE !== $mutator->getType()) {
+                $type = $mutator->getType();
+
+                if (PropertyWriteInfo::TYPE_METHOD === $type) {
+                    $object->{$mutator->getName()}($value);
+                } elseif (PropertyWriteInfo::TYPE_PROPERTY === $type) {
+                    $object->{$mutator->getName()} = $value;
+                } elseif (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $type) {
+                    $this->writeCollection($zval, $property, $value, $mutator->getAdderInfo(), $mutator->getRemoverInfo());
+                }
+            } elseif ($object instanceof \stdClass && property_exists($object, $property)) {
+                $object->$property = $value;
+            } elseif (!$this->ignoreInvalidProperty) {
+                if ($mutator->hasErrors()) {
+                    throw new NoSuchPropertyException(implode('. ', $mutator->getErrors()).'.');
+                }
 
-            if (PropertyWriteInfo::TYPE_METHOD === $type) {
-                $object->{$mutator->getName()}($value);
-            } elseif (PropertyWriteInfo::TYPE_PROPERTY === $type) {
-                $object->{$mutator->getName()} = $value;
-            } elseif (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $type) {
-                $this->writeCollection($zval, $property, $value, $mutator->getAdderInfo(), $mutator->getRemoverInfo());
+                throw new NoSuchPropertyException(sprintf('Could not determine access type for property "%s" in class "%s".', $property, get_debug_type($object)));
             }
-        } elseif ($object instanceof \stdClass && property_exists($object, $property)) {
-            $object->$property = $value;
-        } elseif (!$this->ignoreInvalidProperty) {
-            if ($mutator->hasErrors()) {
-                throw new NoSuchPropertyException(implode('. ', $mutator->getErrors()).'.');
+        } catch (\TypeError $e) {
+            if ($recursive || !$value instanceof \DateTimeInterface || !\in_array($value::class, ['DateTime', 'DateTimeImmutable'], true) || __FILE__ !== $e->getTrace()[0]['file']) {
+                throw $e;
             }
 
-            throw new NoSuchPropertyException(sprintf('Could not determine access type for property "%s" in class "%s".', $property, get_debug_type($object)));
+            $value = $value instanceof \DateTimeImmutable ? \DateTime::createFromImmutable($value) : \DateTimeImmutable::createFromMutable($value);
+            try {
+                $this->writeProperty($zval, $property, $value, true);
+            } catch (\TypeError) {
+                throw $e; // throw the previous error
+            }
         }
     }
 
diff --git a/src/Symfony/Component/PropertyAccess/Tests/Fixtures/TypeHinted.php b/src/Symfony/Component/PropertyAccess/Tests/Fixtures/TypeHinted.php
@@ -28,6 +28,11 @@ public function setDate(\DateTimeImmutable $date)
         $this->date = $date;
     }
 
+    public function setDateMutable(\DateTime $date)
+    {
+        $this->date = $date;
+    }
+
     public function getDate()
     {
         return $this->date;
diff --git a/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php b/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php
@@ -940,4 +940,22 @@ public function testSetValueWrongTypeShouldThrowWrappedException()
         $this->expectExceptionMessage('Expected argument of type "float", "string" given at property path "publicProperty"');
         $this->propertyAccessor->setValue($object, 'publicProperty', 'string');
     }
+
+    public function testCastDateTime()
+    {
+        $object = new TypeHinted();
+
+        $this->propertyAccessor->setValue($object, 'date', new \DateTime());
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $object->getDate());
+    }
+
+    public function testCastDateTimeImmutable()
+    {
+        $object = new TypeHinted();
+
+        $this->propertyAccessor->setValue($object, 'date_mutable', new \DateTimeImmutable());
+
+        $this->assertInstanceOf(\DateTime::class, $object->getDate());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,11 @@ public function setDate(\DateTimeImmutable $date)`
`28`	`28`	`$this->date = $date;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ public function setDateMutable(\DateTime $date)`
	`32`	`+ {`
	`33`	`+ $this->date = $date;`
	`34`	`+ }`
	`35`	`+`
`31`	`36`	`public function getDate()`
`32`	`37`	`{`
`33`	`38`	`return $this->date;`