[DI] Allow binding by type+name

nicolas-grekas · nicolas-grekas · commit f8dc420ba6a4 · 2018-05-05T10:46:33.000-07:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
@@ -208,7 +208,7 @@ private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, a
                         continue;
                     }
                     $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, false);
-                    $type = $type ? sprintf('is type-hinted "%s"', $type) : 'has no type-hint';
+                    $type = $type ? sprintf('is type-hinted "%s"', ltrim($type, '\\')) : 'has no type-hint';
 
                     throw new AutowiringFailedException($this->currentId, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s()" %s, you should configure its value explicitly.', $this->currentId, $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method, $type));
                 }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php
@@ -74,7 +74,7 @@ protected function processValue($value, $isRoot = false)
                 $this->unusedBindings[$bindingId] = array($key, $this->currentId);
             }
 
-            if (isset($key[0]) && '$' === $key[0]) {
+            if (preg_match('/^(?:(?:array|bool|float|int|string) )?\$/', $key)) {
                 continue;
             }
 
@@ -113,15 +113,21 @@ protected function processValue($value, $isRoot = false)
                     continue;
                 }
 
+                $typeHint = ProxyHelper::getTypeHint($reflectionMethod, $parameter);
+
+                if (array_key_exists($k = ltrim($typeHint, '\\').' $'.$parameter->name, $bindings)) {
+                    $arguments[$key] = $this->getBindingValue($bindings[$k]);
+
+                    continue;
+                }
+
                 if (array_key_exists('$'.$parameter->name, $bindings)) {
                     $arguments[$key] = $this->getBindingValue($bindings['$'.$parameter->name]);
 
                     continue;
                 }
 
-                $typeHint = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);
-
-                if (!isset($bindings[$typeHint])) {
+                if (!$typeHint || '\\' !== $typeHint[0] || !isset($bindings[$typeHint = substr($typeHint, 1)])) {
                     continue;
                 }
 
diff --git a/src/Symfony/Component/DependencyInjection/Definition.php b/src/Symfony/Component/DependencyInjection/Definition.php
@@ -859,6 +859,10 @@ public function getBindings()
     public function setBindings(array $bindings)
     {
         foreach ($bindings as $key => $binding) {
+            if (0 < strpos($key, '$') && $key !== $k = preg_replace('/[ \t]*\$/', ' $', $key)) {
+                unset($bindings[$key]);
+                $bindings[$key = $k] = $binding;
+            }
             if (!$binding instanceof BoundArgument) {
                 $bindings[$key] = new BoundArgument($binding);
             }
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/BindTrait.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/BindTrait.php
@@ -31,7 +31,7 @@ trait BindTrait
     final public function bind($nameOrFqcn, $valueOrRef)
     {
         $valueOrRef = static::processValue($valueOrRef, true);
-        if (isset($nameOrFqcn[0]) && '$' !== $nameOrFqcn[0] && !$valueOrRef instanceof Reference) {
+        if (!preg_match('/^(?:(?:array|bool|float|int|string)[ \t]*+)?\$/', $nameOrFqcn) && !$valueOrRef instanceof Reference) {
             throw new InvalidArgumentException(sprintf('Invalid binding for service "%s": named arguments must start with a "$", and FQCN must map to references. Neither applies to binding "%s".', $this->id, $nameOrFqcn));
         }
         $bindings = $this->definition->getBindings();
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php
@@ -95,4 +95,28 @@ public function testScalarSetter()
 
         $this->assertEquals(array(array('setDefaultLocale', array('fr'))), $definition->getMethodCalls());
     }
+
+    public function testTupleBinding()
+    {
+        $container = new ContainerBuilder();
+
+        $bindings = array(
+            '$c' => new BoundArgument(new Reference('bar')),
+            CaseSensitiveClass::class.'$c' => new BoundArgument(new Reference('foo')),
+        );
+
+        $definition = $container->register(NamedArgumentsDummy::class, NamedArgumentsDummy::class);
+        $definition->addMethodCall('setSensitiveClass');
+        $definition->addMethodCall('setAnotherC');
+        $definition->setBindings($bindings);
+
+        $pass = new ResolveBindingsPass();
+        $pass->process($container);
+
+        $expected = array(
+            array('setSensitiveClass', array(new Reference('foo'))),
+            array('setAnotherC', array(new Reference('bar'))),
+        );
+        $this->assertEquals($expected, $definition->getMethodCalls());
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedArgumentsDummy.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedArgumentsDummy.php
@@ -18,4 +18,8 @@ public function setApiKey($apiKey)
     public function setSensitiveClass(CaseSensitiveClass $c)
     {
     }
+
+    public function setAnotherC($c)
+    {
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -132,7 +132,7 @@ public function process(ContainerBuilder $container)
                         } elseif ($p->allowsNull() && !$p->isOptional()) {
                             $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
                         }
-                    } elseif (isset($bindings[$bindingName = '$'.$p->name]) || isset($bindings[$bindingName = $type])) {
+                    } elseif (isset($bindings[$bindingName = $type.' $'.$p->name]) || isset($bindings[$bindingName = '$'.$p->name]) || isset($bindings[$bindingName = $type])) {
                         $binding = $bindings[$bindingName];
 
                         list($bindingValue, $bindingId) = $binding->getValues();
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
@@ -308,7 +308,11 @@ public function testBindings($bindingName)
 
     public function provideBindings()
     {
-        return array(array(ControllerDummy::class), array('$bar'));
+        return array(
+            array(ControllerDummy::class.'$bar'),
+            array(ControllerDummy::class),
+            array('$bar'),
+        );
     }
 
     public function testBindScalarValueToControllerArgument()

Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,7 @@ private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, a`
`208`	`208`	`continue;`
`209`	`209`	`}`
`210`	`210`	`$type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, false);`
`211`		`- $type = $type ? sprintf('is type-hinted "%s"', $type) : 'has no type-hint';`
	`211`	`+ $type = $type ? sprintf('is type-hinted "%s"', ltrim($type, '\\')) : 'has no type-hint';`
`212`	`212`
`213`	`213`	`throw new AutowiringFailedException($this->currentId, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s()" %s, you should configure its value explicitly.', $this->currentId, $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method, $type));`
`214`	`214`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected function processValue($value, $isRoot = false)`
`74`	`74`	`$this->unusedBindings[$bindingId] = array($key, $this->currentId);`
`75`	`75`	`}`
`76`	`76`
`77`		`- if (isset($key[0]) && '$' === $key[0]) {`
	`77`	`+ if (preg_match('/^(?:(?:array\|bool\|float\|int\|string) )?\$/', $key)) {`
`78`	`78`	`continue;`
`79`	`79`	`}`
`80`	`80`
`@@ -113,15 +113,21 @@ protected function processValue($value, $isRoot = false)`
`113`	`113`	`continue;`
`114`	`114`	`}`
`115`	`115`
	`116`	`+ $typeHint = ProxyHelper::getTypeHint($reflectionMethod, $parameter);`
	`117`	`+`
	`118`	`+ if (array_key_exists($k = ltrim($typeHint, '\\').' $'.$parameter->name, $bindings)) {`
	`119`	`+ $arguments[$key] = $this->getBindingValue($bindings[$k]);`
	`120`	`+`
	`121`	`+ continue;`
	`122`	`+ }`
	`123`	`+`
`116`	`124`	`if (array_key_exists('$'.$parameter->name, $bindings)) {`
`117`	`125`	`$arguments[$key] = $this->getBindingValue($bindings['$'.$parameter->name]);`
`118`	`126`
`119`	`127`	`continue;`
`120`	`128`	`}`
`121`	`129`
`122`		`- $typeHint = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);`
`123`		`-`
`124`		`- if (!isset($bindings[$typeHint])) {`
	`130`	`+ if (!$typeHint \|\| '\\' !== $typeHint[0] \|\| !isset($bindings[$typeHint = substr($typeHint, 1)])) {`
`125`	`131`	`continue;`
`126`	`132`	`}`
`127`	`133`
Original file line number	Diff line number	Diff line change
`@@ -859,6 +859,10 @@ public function getBindings()`
`859`	`859`	`public function setBindings(array $bindings)`
`860`	`860`	`{`
`861`	`861`	`foreach ($bindings as $key => $binding) {`
	`862`	`+ if (0 < strpos($key, '$') && $key !== $k = preg_replace('/[ \t]*\$/', ' $', $key)) {`
	`863`	`+ unset($bindings[$key]);`
	`864`	`+ $bindings[$key = $k] = $binding;`
	`865`	`+ }`
`862`	`866`	`if (!$binding instanceof BoundArgument) {`
`863`	`867`	`$bindings[$key] = new BoundArgument($binding);`
`864`	`868`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ trait BindTrait`
`31`	`31`	`final public function bind($nameOrFqcn, $valueOrRef)`
`32`	`32`	`{`
`33`	`33`	`$valueOrRef = static::processValue($valueOrRef, true);`
`34`		`- if (isset($nameOrFqcn[0]) && '$' !== $nameOrFqcn[0] && !$valueOrRef instanceof Reference) {`
	`34`	`+ if (!preg_match('/^(?:(?:array\|bool\|float\|int\|string)[ \t]*+)?\$/', $nameOrFqcn) && !$valueOrRef instanceof Reference) {`
`35`	`35`	`throw new InvalidArgumentException(sprintf('Invalid binding for service "%s": named arguments must start with a "$", and FQCN must map to references. Neither applies to binding "%s".', $this->id, $nameOrFqcn));`
`36`	`36`	`}`
`37`	`37`	`$bindings = $this->definition->getBindings();`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,8 @@ public function setApiKey($apiKey)`
`18`	`18`	`public function setSensitiveClass(CaseSensitiveClass $c)`
`19`	`19`	`{`
`20`	`20`	`}`
	`21`	`+`
	`22`	`+ public function setAnotherC($c)`
	`23`	`+ {`
	`24`	`+ }`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public function process(ContainerBuilder $container)`
`132`	`132`	`} elseif ($p->allowsNull() && !$p->isOptional()) {`
`133`	`133`	`$invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;`
`134`	`134`	`}`
`135`		`- } elseif (isset($bindings[$bindingName = '$'.$p->name]) \|\| isset($bindings[$bindingName = $type])) {`
	`135`	`+ } elseif (isset($bindings[$bindingName = $type.' $'.$p->name]) \|\| isset($bindings[$bindingName = '$'.$p->name]) \|\| isset($bindings[$bindingName = $type])) {`
`136`	`136`	`$binding = $bindings[$bindingName];`
`137`	`137`
`138`	`138`	`list($bindingValue, $bindingId) = $binding->getValues();`
Original file line number	Diff line number	Diff line change
`@@ -308,7 +308,11 @@ public function testBindings($bindingName)`
`308`	`308`
`309`	`309`	`public function provideBindings()`
`310`	`310`	`{`
`311`		`- return array(array(ControllerDummy::class), array('$bar'));`
	`311`	`+ return array(`
	`312`	`+ array(ControllerDummy::class.'$bar'),`
	`313`	`+ array(ControllerDummy::class),`
	`314`	`+ array('$bar'),`
	`315`	`+ );`
`312`	`316`	`}`
`313`	`317`
`314`	`318`	`public function testBindScalarValueToControllerArgument()`