[DI] Add support for getter autowiring

dunglas · dunglas · commit afc023e9d7d1 · 2017-01-10T23:33:44.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
@@ -108,6 +108,10 @@ private function completeDefinition($id, Definition $definition, array $autowire
             $methodsCalled[$methodCall[0]] = true;
         }
 
+        foreach ($definition->getOverriddenGetters() as $overriddenGetter => $returnValue) {
+            $methodsCalled[$overriddenGetter] = true;
+        }
+
         foreach ($this->getMethodsToAutowire($id, $reflectionClass, $autowiredMethods) as $reflectionMethod) {
             if (!isset($methodsCalled[$reflectionMethod->name])) {
                 $this->autowireMethod($id, $definition, $reflectionMethod);
@@ -132,7 +136,7 @@ private function getMethodsToAutowire($id, \ReflectionClass $reflectionClass, ar
             $regexList[] = '/^'.str_replace('\*', '.*', preg_quote($pattern, '/')).'$/i';
         }
 
-        foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflectionMethod) {
+        foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $reflectionMethod) {
             if ($reflectionMethod->isStatic()) {
                 continue;
             }
@@ -164,6 +168,19 @@ private function getMethodsToAutowire($id, \ReflectionClass $reflectionClass, ar
      */
     private function autowireMethod($id, Definition $definition, \ReflectionMethod $reflectionMethod)
     {
+        if (null === $this->types) {
+            $this->populateAvailableTypes();
+        }
+
+        if ($this->overrideGetter($id, $definition, $reflectionMethod)) {
+            return;
+        }
+
+        if ($reflectionMethod->isProtected()) {
+            // Only getter overriding is supported for protected methods
+            return;
+        }
+
         if ($isConstructor = $reflectionMethod->isConstructor()) {
             $arguments = $definition->getArguments();
         } else {
@@ -193,10 +210,6 @@ private function autowireMethod($id, Definition $definition, \ReflectionMethod $
                     continue;
                 }
 
-                if (null === $this->types) {
-                    $this->populateAvailableTypes();
-                }
-
                 if (isset($this->types[$typeHint->name])) {
                     $value = new Reference($this->types[$typeHint->name]);
                     $addMethodCall = true;
@@ -247,6 +260,43 @@ private function autowireMethod($id, Definition $definition, \ReflectionMethod $
         }
     }
 
+    /**
+     * Getter injection.
+     *
+     * @param string            $id
+     * @param Definition        $definition
+     * @param \ReflectionMethod $reflectionMethod
+     *
+     * @return bool
+     */
+    private function overrideGetter($id, Definition $definition, \ReflectionMethod $reflectionMethod)
+    {
+        if (!method_exists($reflectionMethod, 'getReturnType')) {
+            return false;
+        }
+
+        if (0 !== $reflectionMethod->getNumberOfParameters() || $reflectionMethod->isFinal() || $reflectionMethod->returnsReference() || !($returnType = $reflectionMethod->getReturnType())) {
+            return false;
+        }
+
+        $class = (string) $returnType;
+        if (isset($this->types[$class])) {
+            $value = new Reference($this->types[$class]);
+        } else {
+            try {
+                $value = $this->createAutowiredDefinition(new \ReflectionClass($class), $id);
+            } catch (\ReflectionException $e) {
+                return false;
+            } catch (RuntimeException $e) {
+                return false;
+            }
+        }
+
+        $definition->setOverriddenGetter($reflectionMethod->name, $value);
+
+        return true;
+    }
+
     /**
      * Populates the list of available types.
      */
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php
@@ -14,6 +14,7 @@
 use Symfony\Component\DependencyInjection\Compiler\AutowirePass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\GetterOverriding;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
@@ -497,6 +498,31 @@ public function testExplicitMethodInjection()
         );
     }
 
+    /**
+     * @requires PHP 7.1
+     */
+    public function testGetterOverriding()
+    {
+        $container = new ContainerBuilder();
+        $container->register('b', B::class);
+
+        $container
+            ->register('getter_overriding', GetterOverriding::class)
+            ->setOverriddenGetter('getExplicitlyDefined', new Reference('b'))
+            ->setAutowiredMethods(array('get*'))
+        ;
+
+        $pass = new AutowirePass();
+        $pass->process($container);
+
+        $overridenGetters = $container->getDefinition('getter_overriding')->getOverriddenGetters();
+        $this->assertEquals($overridenGetters, array(
+            'getExplicitlyDefined' => new Reference('b'),
+            'getFoo' => new Reference('autowired.symfony\component\dependencyinjection\tests\compiler\foo'),
+            'getBar' => new Reference('autowired.symfony\component\dependencyinjection\tests\compiler\bar'),
+        ));
+    }
+
     /**
      * @dataProvider getCreateResourceTests
      */
@@ -807,6 +833,11 @@ public function notASetter(A $a)
     {
         // should be called only when explicitly specified
     }
+
+    protected function setProtectedMethod(A $a)
+    {
+        // should not be called
+    }
 }
 
 class SetterInjectionCollision
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/GetterOverriding.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/GetterOverriding.php
@@ -0,0 +1,60 @@
+<?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\Fixtures;
+
+/**
+ * To test getter autowiring with PHP >= 7.1.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class GetterOverriding
+{
+    public function getFoo(): ?Foo
+    {
+        // should be called
+    }
+
+    protected function getBar(): Bar
+    {
+        // should be called
+    }
+
+    public function getNoTypeHint()
+    {
+        // should not be called
+    }
+
+    public function getUnknown(): NotExist
+    {
+        // should not be called
+    }
+
+    public function getExplicitlyDefined(): B
+    {
+        // should be called but not autowired
+    }
+
+    public function getScalar(): string
+    {
+        // should not be called
+    }
+
+    final public function getFinal(): A
+    {
+        // should not be called
+    }
+
+    public function &getReference(): A
+    {
+        // should not be called
+    }
+}
