ResolveInstanceofConditionalsPass.php 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  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\RuntimeException;
  15. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  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. if ($definition->getMethodCalls()) {
  33. throw new InvalidArgumentException(sprintf('Autoconfigured instanceof for type "%s" defines method calls but these are not supported and should be removed.', $interface));
  34. }
  35. }
  36. foreach ($container->getDefinitions() as $id => $definition) {
  37. if ($definition instanceof ChildDefinition) {
  38. // don't apply "instanceof" to children: it will be applied to their parent
  39. continue;
  40. }
  41. $container->setDefinition($id, $this->processDefinition($container, $id, $definition));
  42. }
  43. }
  44. private function processDefinition(ContainerBuilder $container, $id, Definition $definition)
  45. {
  46. $instanceofConditionals = $definition->getInstanceofConditionals();
  47. $autoconfiguredInstanceof = $definition->isAutoconfigured() ? $container->getAutoconfiguredInstanceof() : array();
  48. if (!$instanceofConditionals && !$autoconfiguredInstanceof) {
  49. return $definition;
  50. }
  51. if (!$class = $container->getParameterBag()->resolveValue($definition->getClass())) {
  52. return $definition;
  53. }
  54. $conditionals = $this->mergeConditionals($autoconfiguredInstanceof, $instanceofConditionals, $container);
  55. $definition->setInstanceofConditionals(array());
  56. $parent = $shared = null;
  57. $instanceofTags = array();
  58. foreach ($conditionals as $interface => $instanceofDefs) {
  59. if ($interface !== $class && (!$container->getReflectionClass($class, false))) {
  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. $instanceofDef->setTags(array());
  73. if (isset($instanceofDef->getChanges()['shared'])) {
  74. $shared = $instanceofDef->isShared();
  75. }
  76. }
  77. }
  78. if ($parent) {
  79. $abstract = $container->setDefinition('abstract.instanceof.'.$id, $definition);
  80. // cast Definition to ChildDefinition
  81. $definition = serialize($definition);
  82. $definition = substr_replace($definition, '53', 2, 2);
  83. $definition = substr_replace($definition, 'Child', 44, 0);
  84. $definition = unserialize($definition);
  85. $definition->setParent($parent);
  86. if (null !== $shared && !isset($definition->getChanges()['shared'])) {
  87. $definition->setShared($shared);
  88. }
  89. $i = count($instanceofTags);
  90. while (0 <= --$i) {
  91. foreach ($instanceofTags[$i] as $k => $v) {
  92. foreach ($v as $v) {
  93. if ($definition->hasTag($k) && in_array($v, $definition->getTag($k))) {
  94. continue;
  95. }
  96. $definition->addTag($k, $v);
  97. }
  98. }
  99. }
  100. // reset fields with "merge" behavior
  101. $abstract
  102. ->setArguments(array())
  103. ->setMethodCalls(array())
  104. ->setDecoratedService(null)
  105. ->setTags(array())
  106. ->setAbstract(true);
  107. }
  108. return $definition;
  109. }
  110. private function mergeConditionals(array $autoconfiguredInstanceof, array $instanceofConditionals, ContainerBuilder $container)
  111. {
  112. // make each value an array of ChildDefinition
  113. $conditionals = array_map(function ($childDef) { return array($childDef); }, $autoconfiguredInstanceof);
  114. foreach ($instanceofConditionals as $interface => $instanceofDef) {
  115. // make sure the interface/class exists (but don't validate automaticInstanceofConditionals)
  116. if (!$container->getReflectionClass($interface)) {
  117. throw new RuntimeException(sprintf('"%s" is set as an "instanceof" conditional, but it does not exist.', $interface));
  118. }
  119. if (!isset($autoconfiguredInstanceof[$interface])) {
  120. $conditionals[$interface] = array();
  121. }
  122. $conditionals[$interface][] = $instanceofDef;
  123. }
  124. return $conditionals;
  125. }
  126. }