[DI] Add getter injection

nicolas-grekas · nicolas-grekas · commit 03c768014ac7 · 2016-12-17T20:29:11.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php
@@ -75,6 +75,7 @@ public function process(ContainerBuilder $container)
 
             if (!$this->onlyConstructorArguments) {
                 $this->processArguments($definition->getMethodCalls());
+                $this->processArguments($definition->getOverriddenGetters());
                 $this->processArguments($definition->getProperties());
                 if ($definition->getConfigurator()) {
                     $this->processArguments(array($definition->getConfigurator()));
@@ -108,6 +109,7 @@ private function processArguments(array $arguments)
             } elseif ($argument instanceof Definition) {
                 $this->processArguments($argument->getArguments());
                 $this->processArguments($argument->getMethodCalls());
+                $this->processArguments($argument->getOverriddenGetters());
                 $this->processArguments($argument->getProperties());
 
                 if (is_array($argument->getFactory())) {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php
@@ -41,6 +41,7 @@ private function processDefinition(Definition $definition)
     {
         $this->processReferences($definition->getArguments());
         $this->processReferences($definition->getMethodCalls());
+        $this->processReferences($definition->getOverriddenGetters());
         $this->processReferences($definition->getProperties());
     }
 
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckReferenceValidityPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckReferenceValidityPass.php
@@ -47,6 +47,7 @@ public function process(ContainerBuilder $container)
 
             $this->validateReferences($definition->getArguments());
             $this->validateReferences($definition->getMethodCalls());
+            $this->validateReferences($definition->getOverriddenGetters());
             $this->validateReferences($definition->getProperties());
         }
     }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php
@@ -84,6 +84,7 @@ private function inlineArguments(ContainerBuilder $container, array $arguments,
             } elseif ($argument instanceof Definition) {
                 $argument->setArguments($this->inlineArguments($container, $argument->getArguments()));
                 $argument->setMethodCalls($this->inlineArguments($container, $argument->getMethodCalls()));
+                $argument->setOverriddenGetters($this->inlineArguments($container, $argument->getOverriddenGetters()));
                 $argument->setProperties($this->inlineArguments($container, $argument->getProperties()));
 
                 $configurator = $this->inlineArguments($container, array($argument->getConfigurator()));
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php
@@ -76,6 +76,7 @@ public function process(ContainerBuilder $container)
         foreach ($container->getDefinitions() as $definitionId => $definition) {
             $definition->setArguments($this->updateArgumentReferences($replacements, $definitionId, $definition->getArguments()));
             $definition->setMethodCalls($this->updateArgumentReferences($replacements, $definitionId, $definition->getMethodCalls()));
+            $definition->setOverriddenGetters($this->updateArgumentReferences($replacements, $definitionId, $definition->getOverriddenGetters()));
             $definition->setProperties($this->updateArgumentReferences($replacements, $definitionId, $definition->getProperties()));
             $definition->setFactory($this->updateFactoryReference($replacements, $definition->getFactory()));
         }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
@@ -72,6 +72,7 @@ private function resolveArguments(ContainerBuilder $container, array $arguments,
                 }
                 $argument->setArguments($this->resolveArguments($container, $argument->getArguments()));
                 $argument->setMethodCalls($this->resolveArguments($container, $argument->getMethodCalls()));
+                $argument->setOverriddenGetters($this->resolveArguments($container, $argument->getOverriddenGetters()));
                 $argument->setProperties($this->resolveArguments($container, $argument->getProperties()));
 
                 $configurator = $this->resolveArguments($container, array($argument->getConfigurator()));
@@ -131,6 +132,7 @@ private function doResolveDefinition(ContainerBuilder $container, ChildDefinitio
         $def->setClass($parentDef->getClass());
         $def->setArguments($parentDef->getArguments());
         $def->setMethodCalls($parentDef->getMethodCalls());
+        $def->setOverriddenGetters($parentDef->getOverriddenGetters());
         $def->setProperties($parentDef->getProperties());
         $def->setAutowiringTypes($parentDef->getAutowiringTypes());
         if ($parentDef->isDeprecated()) {
@@ -203,6 +205,11 @@ private function doResolveDefinition(ContainerBuilder $container, ChildDefinitio
             $def->setMethodCalls(array_merge($def->getMethodCalls(), $calls));
         }
 
+        // merge overridden getters
+        foreach ($definition->getOverriddenGetters() as $k => $v) {
+            $def->setOverriddenGetter($k, $v);
+        }
+
         // merge autowiring types
         foreach ($definition->getAutowiringTypes() as $autowiringType) {
             $def->addAutowiringType($autowiringType);
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php
@@ -53,6 +53,17 @@ public function process(ContainerBuilder $container)
             }
             $definition->setMethodCalls($calls);
 
+            $getters = array();
+            foreach ($definition->getOverriddenGetters() as $name => $value) {
+                try {
+                    $value = $this->processArguments(array($value), true);
+                    $getters[$name] = reset($value);
+                } catch (RuntimeException $e) {
+                    // this call is simply removed
+                }
+            }
+            $definition->setOverriddenGetters($getters);
+
             $properties = array();
             foreach ($definition->getProperties() as $name => $value) {
                 try {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveParameterPlaceHoldersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveParameterPlaceHoldersPass.php
@@ -51,6 +51,7 @@ public function process(ContainerBuilder $container)
                 }
                 $definition->setMethodCalls($calls);
 
+                $definition->setOverriddenGetters($parameterBag->resolveValue($definition->getOverriddenGetters()));
                 $definition->setProperties($parameterBag->resolveValue($definition->getProperties()));
             } catch (ParameterNotFoundException $e) {
                 $e->setSourceId($id);
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php
@@ -41,6 +41,7 @@ public function process(ContainerBuilder $container)
 
             $definition->setArguments($this->processArguments($definition->getArguments()));
             $definition->setMethodCalls($this->processArguments($definition->getMethodCalls()));
+            $definition->setOverriddenGetters($this->processArguments($definition->getOverriddenGetters()));
             $definition->setProperties($this->processArguments($definition->getProperties()));
             $definition->setFactory($this->processFactory($definition->getFactory()));
         }
diff --git a/src/Symfony/Component/DependencyInjection/Definition.php b/src/Symfony/Component/DependencyInjection/Definition.php
@@ -29,6 +29,7 @@ class Definition
     private $deprecationTemplate = 'The "%service_id%" service is deprecated. You should stop using it, as it will soon be removed.';
     private $properties = array();
     private $calls = array();
+    private $getters = array();
     private $configurator;
     private $tags = array();
     private $public = true;
@@ -319,6 +320,28 @@ public function getMethodCalls()
         return $this->calls;
     }
 
+    public function setOverriddenGetter($name, $returnValue)
+    {
+        if (!$name) {
+            throw new InvalidArgumentException(sprintf('Getter name cannot be empty.'));
+        }
+        $this->getters[$name] = $returnValue;
+
+        return $this;
+    }
+
+    public function setOverriddenGetters(array $getters)
+    {
+        $this->getters = $getters;
+
+        return $this;
+    }
+
+    public function getOverriddenGetters()
+    {
+        return $this->getters;
+    }
+
     /**
      * Sets tags for this definition.
      *
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php
@@ -79,6 +79,13 @@ public function dump(array $options = array())
                     $this->findEdges($id, $call[1], false, $call[0].'()')
                 );
             }
+
+            foreach ($definition->getOverriddenGetters() as $name => $value) {
+                $this->edges[$id] = array_merge(
+                    $this->edges[$id],
+                    $this->findEdges($id, $value, false, $name.'()')
+                );
+            }
         }
 
         return $this->container->resolveEnvPlaceholders($this->startDot().$this->addNodes().$this->addEdges().$this->endDot(), '__ENV_%s__');
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ private function processDefinition(Definition $definition)`
`41`	`41`	`{`
`42`	`42`	`$this->processReferences($definition->getArguments());`
`43`	`43`	`$this->processReferences($definition->getMethodCalls());`
	`44`	`+ $this->processReferences($definition->getOverriddenGetters());`
`44`	`45`	`$this->processReferences($definition->getProperties());`
`45`	`46`	`}`
`46`	`47`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ public function process(ContainerBuilder $container)`
`47`	`47`
`48`	`48`	`$this->validateReferences($definition->getArguments());`
`49`	`49`	`$this->validateReferences($definition->getMethodCalls());`
	`50`	`+ $this->validateReferences($definition->getOverriddenGetters());`
`50`	`51`	`$this->validateReferences($definition->getProperties());`
`51`	`52`	`}`
`52`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ public function process(ContainerBuilder $container)`
`76`	`76`	`foreach ($container->getDefinitions() as $definitionId => $definition) {`
`77`	`77`	`$definition->setArguments($this->updateArgumentReferences($replacements, $definitionId, $definition->getArguments()));`
`78`	`78`	`$definition->setMethodCalls($this->updateArgumentReferences($replacements, $definitionId, $definition->getMethodCalls()));`
	`79`	`+ $definition->setOverriddenGetters($this->updateArgumentReferences($replacements, $definitionId, $definition->getOverriddenGetters()));`
`79`	`80`	`$definition->setProperties($this->updateArgumentReferences($replacements, $definitionId, $definition->getProperties()));`
`80`	`81`	`$definition->setFactory($this->updateFactoryReference($replacements, $definition->getFactory()));`
`81`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public function process(ContainerBuilder $container)`
`51`	`51`	`}`
`52`	`52`	`$definition->setMethodCalls($calls);`
`53`	`53`
	`54`	`+ $definition->setOverriddenGetters($parameterBag->resolveValue($definition->getOverriddenGetters()));`
`54`	`55`	`$definition->setProperties($parameterBag->resolveValue($definition->getProperties()));`
`55`	`56`	`} catch (ParameterNotFoundException $e) {`
`56`	`57`	`$e->setSourceId($id);`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ public function process(ContainerBuilder $container)`
`41`	`41`
`42`	`42`	`$definition->setArguments($this->processArguments($definition->getArguments()));`
`43`	`43`	`$definition->setMethodCalls($this->processArguments($definition->getMethodCalls()));`
	`44`	`+ $definition->setOverriddenGetters($this->processArguments($definition->getOverriddenGetters()));`
`44`	`45`	`$definition->setProperties($this->processArguments($definition->getProperties()));`
`45`	`46`	`$definition->setFactory($this->processFactory($definition->getFactory()));`
`46`	`47`	`}`