[DI] Rework config hierarchy: defaults > instanceof > service config

symfony · fabpot · Apr 11, 2017 · Apr 5, 2017 · Apr 7, 2017 · Apr 11, 2017
commit ab86457b12db9b6cedb158fd6a54d6aa34219b2c
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -42,7 +42,8 @@ public function __construct()
         $this->beforeOptimizationPasses = array(
             100 => array(
                 $resolveClassPass = new ResolveClassPass(),
-                new ResolveDefinitionInheritancePass(),
+                new ResolveInstanceofConditionalsPass(),
+                new ResolveTagsInheritancePass(),
             ),
         );
 

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionInheritancePass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionInheritancePass.php
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
@@ -84,7 +84,7 @@ private function doResolveDefinition(ChildDefinition $definition)
         $def = new Definition();
 
         // merge in parent definition
-        // purposely ignored attributes: abstract, tags
+        // purposely ignored attributes: abstract, shared, tags
         $def->setClass($parentDef->getClass());
         $def->setArguments($parentDef->getArguments());
         $def->setMethodCalls($parentDef->getMethodCalls());
@@ -101,27 +101,8 @@ private function doResolveDefinition(ChildDefinition $definition)
         $def->setPublic($parentDef->isPublic());
         $def->setLazy($parentDef->isLazy());
         $def->setAutowired($parentDef->isAutowired());
+        $def->setChanges($parentDef->getChanges());
 
-        self::mergeDefinition($def, $definition);
-
-        // merge autowiring types
-        foreach ($definition->getAutowiringTypes(false) as $autowiringType) {
-            $def->addAutowiringType($autowiringType);
-        }
-
-        // these attributes are always taken from the child
-        $def->setAbstract($definition->isAbstract());
-        $def->setShared($definition->isShared());
-        $def->setTags($definition->getTags());
-
-        return $def;
-    }
-
-    /**
-     * @internal
-     */
-    public static function mergeDefinition(Definition $def, ChildDefinition $definition)
-    {
         // overwrite with values specified in the decorator
         $changes = $definition->getChanges();
         if (isset($changes['class'])) {
@@ -148,6 +129,9 @@ public static function mergeDefinition(Definition $def, ChildDefinition $definit
         if (isset($changes['autowired'])) {
             $def->setAutowired($definition->isAutowired());
         }
+        if (isset($changes['shared'])) {
+            $def->setShared($definition->isShared());
+        }
         if (isset($changes['decorated_service'])) {
             $decoratedService = $definition->getDecoratedService();
             if (null === $decoratedService) {
@@ -182,5 +166,16 @@ public static function mergeDefinition(Definition $def, ChildDefinition $definit
         if ($calls = $definition->getMethodCalls()) {
             $def->setMethodCalls(array_merge($def->getMethodCalls(), $calls));
         }
+
+        // merge autowiring types
+        foreach ($definition->getAutowiringTypes(false) as $autowiringType) {
+            $def->addAutowiringType($autowiringType);
+        }
+
+        // these attributes are always taken from the child
+        $def->setAbstract($definition->isAbstract());
+        $def->setTags($definition->getTags());
+
+        return $def;
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveInstanceofConditionalsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveInstanceofConditionalsPass.php
@@ -0,0 +1,90 @@
+<?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\Compiler;
+
+use Symfony\Component\DependencyInjection\ChildDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+/**
+ * Applies instanceof conditionals to definitions.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class ResolveInstanceofConditionalsPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $didProcess = false;
+        foreach ($container->getDefinitions() as $id => $definition) {
+            if ($definition instanceof ChildDefinition) {
+                continue;
+            }
+            if ($definition !== $processedDefinition = $this->processDefinition($container, $id, $definition)) {
+                $didProcess = true;
+                $container->setDefinition($id, $processedDefinition);
+            }
+        }
+        if ($didProcess) {
+            $container->register('abstract.'.__CLASS__, '')->setAbstract(true);
+        }
+    }
+
+    private function processDefinition(ContainerBuilder $container, $id, Definition $definition)
+    {
+        if (!$instanceofConditionals = $definition->getInstanceofConditionals()) {
+            return $definition;
+        }
+        if (!$class = $container->getParameterBag()->resolveValue($definition->getClass())) {
+            return $definition;
+        }
+
+        $definition->setInstanceofConditionals(array());
+        $instanceofParent = null;
+        $parent = 'abstract.'.__CLASS__;
+        $shared = null;
+
+        foreach ($instanceofConditionals as $interface => $instanceofDef) {
+            if ($interface !== $class && (!$container->getReflectionClass($interface) || !$container->getReflectionClass($class))) {
+                continue;
+            }
+            if ($interface === $class || is_subclass_of($class, $interface)) {
+                $instanceofParent = clone $instanceofDef;
+                $instanceofParent->setAbstract(true)->setInheritTags(true)->setParent($parent);
+                $parent = 'instanceof.'.$interface.'.'.$id;
+                $container->setDefinition($parent, $instanceofParent);
+
+                if (isset($instanceofParent->getChanges()['shared'])) {
+                    $shared = $instanceofParent->isShared();
+                }
+            }
+        }
+
+        if ($instanceofParent) {
+            // cast Definition to ChildDefinition
+            $definition = serialize($definition);
+            $definition = substr_replace($definition, '53', 2, 2);
+            $definition = substr_replace($definition, 'Child', 44, 0);
+            $definition = unserialize($definition);
+            $definition->setInheritTags(true)->setParent($parent);
+
+            if (null !== $shared && !isset($definition->getChanges()['shared'])) {
+                $definition->setShared($shared);
+            }
+        }
+
+        return $definition;
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveTagsInheritancePass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveTagsInheritancePass.php
@@ -0,0 +1,51 @@
+<?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\Compiler;
+
+use Symfony\Component\DependencyInjection\ChildDefinition;
+
+/**
+ * Applies tags inheritance to definitions.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class ResolveTagsInheritancePass extends AbstractRecursivePass
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function processValue($value, $isRoot = false)
+    {
+        if (!$value instanceof ChildDefinition || !$value->getInheritTags()) {
+            return parent::processValue($value, $isRoot);
+        }
+        $value->setInheritTags(false);
+
+        if (!$this->container->has($parent = $value->getParent())) {
+            return parent::processValue($value, $isRoot);
+        }
+
+        $parentDef = $this->container->findDefinition($parent);
+
+        if ($parentDef instanceof ChildDefinition) {
+            $this->processValue($parentDef);
+        }
+
+        foreach ($parentDef->getTags() as $k => $v) {
+            foreach ($v as $v) {
+                $value->addTag($k, $v);
+            }
+        }
+
+        return parent::processValue($value, $isRoot);
+    }
+}