ResolveInstanceofConditionalsPass.php 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\DependencyInjection\Compiler;
  11. use Symfony\Component\DependencyInjection\ChildDefinition;
  12. use Symfony\Component\DependencyInjection\ContainerBuilder;
  13. use Symfony\Component\DependencyInjection\Definition;
  14. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  15. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  16. /**
  17. * Applies instanceof conditionals to definitions.
  18. *
  19. * @author Nicolas Grekas <p@tchwork.com>
  20. */
  21. class ResolveInstanceofConditionalsPass implements CompilerPassInterface
  22. {
  23. /**
  24. * {@inheritdoc}
  25. */
  26. public function process(ContainerBuilder $container)
  27. {
  28. foreach ($container->getAutoconfiguredInstanceof() as $interface => $definition) {
  29. if ($definition->getArguments()) {
  30. throw new InvalidArgumentException(sprintf('Autoconfigured instanceof for type "%s" defines arguments but these are not supported and should be removed.', $interface));
  31. }
  32. }
  33. foreach ($container->getDefinitions() as $id => $definition) {
  34. if ($definition instanceof ChildDefinition) {
  35. // don't apply "instanceof" to children: it will be applied to their parent
  36. continue;
  37. }
  38. $container->setDefinition($id, $this->processDefinition($container, $id, $definition));
  39. }
  40. }
  41. private function processDefinition(ContainerBuilder $container, string $id, Definition $definition): Definition
  42. {
  43. $instanceofConditionals = $definition->getInstanceofConditionals();
  44. $autoconfiguredInstanceof = $definition->isAutoconfigured() ? $container->getAutoconfiguredInstanceof() : [];
  45. if (!$instanceofConditionals && !$autoconfiguredInstanceof) {
  46. return $definition;
  47. }
  48. if (!$class = $container->getParameterBag()->resolveValue($definition->getClass())) {
  49. return $definition;
  50. }
  51. $conditionals = $this->mergeConditionals($autoconfiguredInstanceof, $instanceofConditionals, $container);
  52. $definition->setInstanceofConditionals([]);
  53. $parent = $shared = null;
  54. $instanceofTags = [];
  55. $instanceofCalls = [];
  56. $instanceofBindings = [];
  57. $reflectionClass = null;
  58. foreach ($conditionals as $interface => $instanceofDefs) {
  59. if ($interface !== $class && !(null === $reflectionClass ? $reflectionClass = ($container->getReflectionClass($class, false) ?: false) : $reflectionClass)) {
  60. continue;
  61. }
  62. if ($interface !== $class && !is_subclass_of($class, $interface)) {
  63. continue;
  64. }
  65. foreach ($instanceofDefs as $key => $instanceofDef) {
  66. /** @var ChildDefinition $instanceofDef */
  67. $instanceofDef = clone $instanceofDef;
  68. $instanceofDef->setAbstract(true)->setParent($parent ?: '.abstract.instanceof.'.$id);
  69. $parent = '.instanceof.'.$interface.'.'.$key.'.'.$id;
  70. $container->setDefinition($parent, $instanceofDef);
  71. $instanceofTags[] = $instanceofDef->getTags();
  72. $instanceofBindings = $instanceofDef->getBindings() + $instanceofBindings;
  73. foreach ($instanceofDef->getMethodCalls() as $methodCall) {
  74. $instanceofCalls[] = $methodCall;
  75. }
  76. $instanceofDef->setTags([]);
  77. $instanceofDef->setMethodCalls([]);
  78. $instanceofDef->setBindings([]);
  79. if (isset($instanceofDef->getChanges()['shared'])) {
  80. $shared = $instanceofDef->isShared();
  81. }
  82. }
  83. }
  84. if ($parent) {
  85. $bindings = $definition->getBindings();
  86. $abstract = $container->setDefinition('.abstract.instanceof.'.$id, $definition);
  87. // cast Definition to ChildDefinition
  88. $definition->setBindings([]);
  89. $definition = serialize($definition);
  90. $definition = substr_replace($definition, '53', 2, 2);
  91. $definition = substr_replace($definition, 'Child', 44, 0);
  92. /** @var ChildDefinition $definition */
  93. $definition = unserialize($definition);
  94. $definition->setParent($parent);
  95. if (null !== $shared && !isset($definition->getChanges()['shared'])) {
  96. $definition->setShared($shared);
  97. }
  98. // Don't add tags to service decorators
  99. if (null === $definition->getDecoratedService()) {
  100. $i = \count($instanceofTags);
  101. while (0 <= --$i) {
  102. foreach ($instanceofTags[$i] as $k => $v) {
  103. foreach ($v as $v) {
  104. if ($definition->hasTag($k) && \in_array($v, $definition->getTag($k))) {
  105. continue;
  106. }
  107. $definition->addTag($k, $v);
  108. }
  109. }
  110. }
  111. }
  112. $definition->setMethodCalls(array_merge($instanceofCalls, $definition->getMethodCalls()));
  113. $definition->setBindings($bindings + $instanceofBindings);
  114. // reset fields with "merge" behavior
  115. $abstract
  116. ->setBindings([])
  117. ->setArguments([])
  118. ->setMethodCalls([])
  119. ->setDecoratedService(null)
  120. ->setTags([])
  121. ->setAbstract(true);
  122. }
  123. return $definition;
  124. }
  125. private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container): array
  126. {
  127. // make each value an array of ChildDefinition
  128. $conditionals = array_map(function ($childDef) { return [$childDef]; }, $autoconfiguredInstanceof);
  129. foreach ($instanceofConditionals as $interface => $instanceofDef) {
  130. // make sure the interface/class exists (but don't validate automaticInstanceofConditionals)
  131. if (!$container->getReflectionClass($interface)) {
  132. throw new RuntimeException(sprintf('"%s" is set as an "instanceof" conditional, but it does not exist.', $interface));
  133. }
  134. if (!isset($autoconfiguredInstanceof[$interface])) {
  135. $conditionals[$interface] = [];
  136. }
  137. $conditionals[$interface][] = $instanceofDef;
  138. }
  139. return $conditionals;
  140. }
  141. }