[DependencyInjection] Fix InvalidParameterTypeException for function parameters

derrabus · derrabus · commit 21072d57d416 · 2021-01-07T02:06:44.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Exception/InvalidParameterTypeException.php b/src/Symfony/Component/DependencyInjection/Exception/InvalidParameterTypeException.php
@@ -25,6 +25,11 @@ public function __construct(string $serviceId, string $type, \ReflectionParamete
         $acceptedType = $acceptedType instanceof \ReflectionNamedType ? $acceptedType->getName() : (string) $acceptedType;
         $this->code = $type;
 
-        parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s()" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $acceptedType, $type));
+        $function = $parameter->getDeclaringFunction();
+        $functionName = $function instanceof \ReflectionMethod
+            ? sprintf('%s::%s', $function->getDeclaringClass()->getName(), $function->getName())
+            : $function->getName();
+
+        parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s()" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $functionName, $acceptedType, $type));
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Exception/InvalidParameterTypeExceptionTest.php b/src/Symfony/Component/DependencyInjection/Tests/Exception/InvalidParameterTypeExceptionTest.php
@@ -0,0 +1,52 @@
+<?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\DependencyInjection\Tests\Exception;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Exception\InvalidParameterTypeException;
+
+final class InvalidParameterTypeExceptionTest extends TestCase
+{
+    /**
+     * @dataProvider provideReflectionParameters
+     */
+    public function testExceptionMessage(\ReflectionParameter $parameter, string $expectedMessage)
+    {
+        $exception = new InvalidParameterTypeException('my_service', 'int', $parameter);
+
+        self::assertSame($expectedMessage, $exception->getMessage());
+    }
+
+    public function provideReflectionParameters(): iterable
+    {
+        yield 'static method' => [
+            new \ReflectionParameter([MyClass::class, 'doSomething'], 0),
+            'Invalid definition for service "my_service": argument 1 of "Symfony\Component\DependencyInjection\Tests\Exception\MyClass::doSomething()" accepts "array", "int" passed.'
+        ];
+
+        yield 'function' => [
+            new \ReflectionParameter(__NAMESPACE__.'\\myFunction', 0),
+            'Invalid definition for service "my_service": argument 1 of "Symfony\Component\DependencyInjection\Tests\Exception\myFunction()" accepts "array", "int" passed.'
+        ];
+    }
+}
+
+class MyClass
+{
+    public static function doSomething(array $arguments): void
+    {
+    }
+}
+
+function myFunction(array $arguments): void
+{
+}

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,11 @@ public function __construct(string $serviceId, string $type, \ReflectionParamete`
`25`	`25`	`$acceptedType = $acceptedType instanceof \ReflectionNamedType ? $acceptedType->getName() : (string) $acceptedType;`
`26`	`26`	`$this->code = $type;`
`27`	`27`
`28`		`- parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s()" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $acceptedType, $type));`
	`28`	`+ $function = $parameter->getDeclaringFunction();`
	`29`	`+ $functionName = $function instanceof \ReflectionMethod`
	`30`	`+ ? sprintf('%s::%s', $function->getDeclaringClass()->getName(), $function->getName())`
	`31`	`+ : $function->getName();`
	`32`	`+`
	`33`	`+ parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s()" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $functionName, $acceptedType, $type));`
`29`	`34`	`}`
`30`	`35`	`}`