bug #28220 [PropertyAccess] fix type error handling when writing values (xabbuh)

nicolas-grekas · nicolas-grekas · commit e18bf6eee0b0 · 2018-08-24T11:57:25.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [PropertyAccess] fix type error handling when writing values | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Commits ------- 4575451 fix type error handling when writing values
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -231,7 +231,12 @@ public static function handleError($type, $message, $file, $line, $context)
 
     private static function throwInvalidArgumentException($message, $trace, $i)
     {
-        if (isset($trace[$i]['file']) && __FILE__ === $trace[$i]['file'] && isset($trace[$i]['args'][0])) {
+        // the type mismatch is not caused by invalid arguments (but e.g. by an incompatible return type hint of the writer method)
+        if (0 !== strpos($message, 'Argument ')) {
+            return;
+        }
+
+        if (isset($trace[$i]['file']) && __FILE__ === $trace[$i]['file'] && array_key_exists(0, $trace[$i]['args'])) {
             $pos = strpos($message, $delim = 'must be of the type ') ?: (strpos($message, $delim = 'must be an instance of ') ?: strpos($message, $delim = 'must implement interface '));
             $pos += \strlen($delim);
             $type = $trace[$i]['args'][0];
diff --git a/src/Symfony/Component/PropertyAccess/Tests/Fixtures/ReturnTyped.php b/src/Symfony/Component/PropertyAccess/Tests/Fixtures/ReturnTyped.php
@@ -28,4 +28,9 @@ public function addFoo(\DateTime $dateTime)
     public function removeFoo(\DateTime $dateTime)
     {
     }
+
+    public function setName($name): self
+    {
+        return 'This does not respect the return type on purpose.';
+    }
 }
diff --git a/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php b/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php
@@ -538,6 +538,17 @@ public function testThrowTypeError()
         $this->propertyAccessor->setValue($object, 'date', 'This is a string, \DateTime expected.');
     }
 
+    /**
+     * @expectedException \Symfony\Component\PropertyAccess\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Expected argument of type "DateTime", "NULL" given
+     */
+    public function testThrowTypeErrorWithNullArgument()
+    {
+        $object = new TypeHinted();
+
+        $this->propertyAccessor->setValue($object, 'date', null);
+    }
+
     public function testSetTypeHint()
     {
         $date = new \DateTime();
@@ -579,4 +590,16 @@ public function testDoNotDiscardReturnTypeError()
 
         $this->propertyAccessor->setValue($object, 'foos', array(new \DateTime()));
     }
+
+    /**
+     * @requires PHP 7
+     *
+     * @expectedException \TypeError
+     */
+    public function testDoNotDiscardReturnTypeErrorWhenWriterMethodIsMisconfigured()
+    {
+        $object = new ReturnTyped();
+
+        $this->propertyAccessor->setValue($object, 'name', 'foo');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,9 @@ public function addFoo(\DateTime $dateTime)`
`28`	`28`	`public function removeFoo(\DateTime $dateTime)`
`29`	`29`	`{`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+ public function setName($name): self`
	`33`	`+ {`
	`34`	`+ return 'This does not respect the return type on purpose.';`
	`35`	`+ }`
`31`	`36`	`}`