vendor/symfony/symfony/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php line 304

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\DependencyInjection\Compiler;
  14. use Symfony\Component\Config\Resource\ClassExistenceResource;
  15. use Symfony\Component\DependencyInjection\Config\AutowireServiceResource;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\DependencyInjection\Definition;
  18. use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
  19. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  20. use Symfony\Component\DependencyInjection\LazyProxy\ProxyHelper;
  21. use Symfony\Component\DependencyInjection\TypedReference;
  23. /**
  24.  * Inspects existing service definitions and wires the autowired ones using the type hints of their classes.
  25.  *
  26.  * @author Kévin Dunglas <dunglas@gmail.com>
  27.  * @author Nicolas Grekas <p@tchwork.com>
  28.  */
  29. class AutowirePass extends AbstractRecursivePass
  30. {
  31.     private $definedTypes = array();
  32.     private $types;
  33.     private $ambiguousServiceTypes = array();
  34.     private $autowired = array();
  35.     private $lastFailure;
  36.     private $throwOnAutowiringException;
  37.     private $autowiringExceptions = array();
  38.     private $strictMode;
  40.     /**
  41.      * @param bool $throwOnAutowireException Errors can be retrieved via Definition::getErrors()
  42.      */
  43.     public function __construct($throwOnAutowireException = true)
  44.     {
  45.         $this->throwOnAutowiringException = $throwOnAutowireException;
  46.     }
  48.     /**
  49.      * @deprecated since version 3.4, to be removed in 4.0.
  50.      *
  51.      * @return AutowiringFailedException[]
  52.      */
  53.     public function getAutowiringExceptions()
  54.     {
  55.         @trigger_error('Calling AutowirePass::getAutowiringExceptions() is deprecated since Symfony 3.4 and will be removed in 4.0. Use Definition::getErrors() instead.', E_USER_DEPRECATED);
  57.         return $this->autowiringExceptions;
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      */
  63.     public function process(ContainerBuilder $container)
  64.     {
  65.         // clear out any possibly stored exceptions from before
  66.         $this->autowiringExceptions = array();
  67.         $this->strictMode = $container->hasParameter('container.autowiring.strict_mode') && $container->getParameter('container.autowiring.strict_mode');
  69.         try {
  70.             parent::process($container);
  71.         } finally {
  72.             $this->definedTypes = array();
  73.             $this->types = null;
  74.             $this->ambiguousServiceTypes = array();
  75.             $this->autowired = array();
  76.         }
  77.     }
  79.     /**
  80.      * Creates a resource to help know if this service has changed.
  81.      *
  82.      * @param \ReflectionClass $reflectionClass
  83.      *
  84.      * @return AutowireServiceResource
  85.      *
  86.      * @deprecated since version 3.3, to be removed in 4.0. Use ContainerBuilder::getReflectionClass() instead.
  87.      */
  88.     public static function createResourceForClass(\ReflectionClass $reflectionClass)
  89.     {
  90.         @trigger_error('The '.__METHOD__.'() method is deprecated since Symfony 3.3 and will be removed in 4.0. Use ContainerBuilder::getReflectionClass() instead.', E_USER_DEPRECATED);
  92.         $metadata = array();
  94.         foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflectionMethod) {
  95.             if (!$reflectionMethod->isStatic()) {
  96.                 $metadata[$reflectionMethod->name] = self::getResourceMetadataForMethod($reflectionMethod);
  97.             }
  98.         }
  100.         return new AutowireServiceResource($reflectionClass->name, $reflectionClass->getFileName(), $metadata);
  101.     }
  103.     /**
  104.      * {@inheritdoc}
  105.      */
  106.     protected function processValue($value, $isRoot = false)
  107.     {
  108.         try {
  109.             return $this->doProcessValue($value, $isRoot);
  110.         } catch (AutowiringFailedException $e) {
  111.             if ($this->throwOnAutowiringException) {
  112.                 throw $e;
  113.             }
  115.             $this->autowiringExceptions[] = $e;
  116.             $this->container->getDefinition($this->currentId)->addError($e->getMessage());
  118.             return parent::processValue($value, $isRoot);
  119.         }
  120.     }
  122.     private function doProcessValue($value, $isRoot = false)
  123.     {
  124.         if ($value instanceof TypedReference) {
  125.             if ($ref = $this->getAutowiredReference($value, $value->getRequiringClass() ? sprintf('for "%s" in "%s"', $value->getType(), $value->getRequiringClass()) : '')) {
  126.                 return $ref;
  127.             }
  128.             $this->container->log($this, $this->createTypeNotFoundMessage($value, 'it'));
  129.         }
  130.         $value = parent::processValue($value, $isRoot);
  132.         if (!$value instanceof Definition || !$value->isAutowired() || $value->isAbstract() || !$value->getClass()) {
  133.             return $value;
  134.         }
  135.         if (!$reflectionClass = $this->container->getReflectionClass($value->getClass(), false)) {
  136.             $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" cannot be loaded.', $this->currentId, $value->getClass()));
  138.             return $value;
  139.         }
  141.         $methodCalls = $value->getMethodCalls();
  143.         try {
  144.             $constructor = $this->getConstructor($value, false);
  145.         } catch (RuntimeException $e) {
  146.             throw new AutowiringFailedException($this->currentId, $e->getMessage(), 0, $e);
  147.         }
  149.         if ($constructor) {
  150.             array_unshift($methodCalls, array($constructor, $value->getArguments()));
  151.         }
  153.         $methodCalls = $this->autowireCalls($reflectionClass, $methodCalls);
  155.         if ($constructor) {
  156.             list(, $arguments) = array_shift($methodCalls);
  158.             if ($arguments !== $value->getArguments()) {
  159.                 $value->setArguments($arguments);
  160.             }
  161.         }
  163.         if ($methodCalls !== $value->getMethodCalls()) {
  164.             $value->setMethodCalls($methodCalls);
  165.         }
  167.         return $value;
  168.     }
  170.     /**
  171.      * @param \ReflectionClass $reflectionClass
  172.      * @param array            $methodCalls
  173.      *
  174.      * @return array
  175.      */
  176.     private function autowireCalls(\ReflectionClass $reflectionClass, array $methodCalls)
  177.     {
  178.         foreach ($methodCalls as $i => $call) {
  179.             list($method, $arguments) = $call;
  181.             if ($method instanceof \ReflectionFunctionAbstract) {
  182.                 $reflectionMethod = $method;
  183.             } else {
  184.                 $reflectionMethod = $this->getReflectionMethod(new Definition($reflectionClass->name), $method);
  185.             }
  187.             $arguments = $this->autowireMethod($reflectionMethod, $arguments);
  189.             if ($arguments !== $call[1]) {
  190.                 $methodCalls[$i][1] = $arguments;
  191.             }
  192.         }
  194.         return $methodCalls;
  195.     }
  197.     /**
  198.      * Autowires the constructor or a method.
  199.      *
  200.      * @param \ReflectionFunctionAbstract $reflectionMethod
  201.      * @param array                       $arguments
  202.      *
  203.      * @return array The autowired arguments
  204.      *
  205.      * @throws AutowiringFailedException
  206.      */
  207.     private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, array $arguments)
  208.     {
  209.         $class = $reflectionMethod instanceof \ReflectionMethod ? $reflectionMethod->class : $this->currentId;
  210.         $method = $reflectionMethod->name;
  211.         $parameters = $reflectionMethod->getParameters();
  212.         if (method_exists('ReflectionMethod', 'isVariadic') && $reflectionMethod->isVariadic()) {
  213.             array_pop($parameters);
  214.         }
  216.         foreach ($parameters as $index => $parameter) {
  217.             if (array_key_exists($index, $arguments) && '' !== $arguments[$index]) {
  218.                 continue;
  219.             }
  221.             $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);
  223.             if (!$type) {
  224.                 if (isset($arguments[$index])) {
  225.                     continue;
  226.                 }
  228.                 // no default value? Then fail
  229.                 if (!$parameter->isDefaultValueAvailable()) {
  230.                     // For core classes, isDefaultValueAvailable() can
  231.                     // be false when isOptional() returns true. If the
  232.                     // argument *is* optional, allow it to be missing
  233.                     if ($parameter->isOptional()) {
  234.                         continue;
  235.                     }
  236.                     throw new AutowiringFailedException($this->currentId, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s()" must have a type-hint or be given a value explicitly.', $this->currentId, $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method));
  237.                 }
  239.                 // specifically pass the default value
  240.                 $arguments[$index] = $parameter->getDefaultValue();
  242.                 continue;
  243.             }
  245.             if (!$value = $this->getAutowiredReference($ref = new TypedReference($type, $type, !$parameter->isOptional() ? $class : ''), 'for '.sprintf('argument "$%s" of method "%s()"', $parameter->name, $class.'::'.$method))) {
  246.                 $failureMessage = $this->createTypeNotFoundMessage($ref, sprintf('argument "$%s" of method "%s()"', $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method));
  248.                 if ($parameter->isDefaultValueAvailable()) {
  249.                     $value = $parameter->getDefaultValue();
  250.                 } elseif (!$parameter->allowsNull()) {
  251.                     throw new AutowiringFailedException($this->currentId, $failureMessage);
  252.                 }
  253.                 $this->container->log($this, $failureMessage);
  254.             }
  256.             $arguments[$index] = $value;
  257.         }
  259.         if ($parameters && !isset($arguments[++$index])) {
  260.             while (0 <= --$index) {
  261.                 $parameter = $parameters[$index];
  262.                 if (!$parameter->isDefaultValueAvailable() || $parameter->getDefaultValue() !== $arguments[$index]) {
  263.                     break;
  264.                 }
  265.                 unset($arguments[$index]);
  266.             }
  267.         }
  269.         // it's possible index 1 was set, then index 0, then 2, etc
  270.         // make sure that we re-order so they're injected as expected
  271.         ksort($arguments);
  273.         return $arguments;
  274.     }
  276.     /**
  277.      * @return TypedReference|null A reference to the service matching the given type, if any
  278.      */
  279.     private function getAutowiredReference(TypedReference $reference, $deprecationMessage)
  280.     {
  281.         $this->lastFailure = null;
  282.         $type = $reference->getType();
  284.         if ($type !== $this->container->normalizeId($reference) || ($this->container->has($type) && !$this->container->findDefinition($type)->isAbstract())) {
  285.             return $reference;
  286.         }
  288.         if (null === $this->types) {
  289.             $this->populateAvailableTypes();
  290.         }
  292.         if (isset($this->definedTypes[$type])) {
  293.             return new TypedReference($this->types[$type], $type);
  294.         }
  296.         if (!$this->strictMode && isset($this->types[$type])) {
  297.             $message = 'Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won\'t be supported in version 4.0.';
  298.             if ($aliasSuggestion = $this->getAliasesSuggestionForType($type = $reference->getType(), $deprecationMessage)) {
  299.                 $message .= ' '.$aliasSuggestion;
  300.             } else {
  301.                 $message .= sprintf(' You should %s the "%s" service to "%s" instead.', isset($this->types[$this->types[$type]]) ? 'alias' : 'rename (or alias)', $this->types[$type], $type);
  302.             }
  304.             @trigger_error($message, E_USER_DEPRECATED);
  306.             return new TypedReference($this->types[$type], $type);
  307.         }
  309.         if (!$reference->canBeAutoregistered() || isset($this->types[$type]) || isset($this->ambiguousServiceTypes[$type])) {
  310.             return;
  311.         }
  313.         if (isset($this->autowired[$type])) {
  314.             return $this->autowired[$type] ? new TypedReference($this->autowired[$type], $type) : null;
  315.         }
  317.         if (!$this->strictMode) {
  318.             return $this->createAutowiredDefinition($type);
  319.         }
  320.     }
  322.     /**
  323.      * Populates the list of available types.
  324.      */
  325.     private function populateAvailableTypes()
  326.     {
  327.         $this->types = array();
  329.         foreach ($this->container->getDefinitions() as $id => $definition) {
  330.             $this->populateAvailableType($id, $definition);
  331.         }
  332.     }
  334.     /**
  335.      * Populates the list of available types for a given definition.
  336.      *
  337.      * @param string     $id
  338.      * @param Definition $definition
  339.      */
  340.     private function populateAvailableType($id, Definition $definition)
  341.     {
  342.         // Never use abstract services
  343.         if ($definition->isAbstract()) {
  344.             return;
  345.         }
  347.         foreach ($definition->getAutowiringTypes(false) as $type) {
  348.             $this->definedTypes[$type] = true;
  349.             $this->types[$type] = $id;
  350.             unset($this->ambiguousServiceTypes[$type]);
  351.         }
  353.         if (preg_match('/^\d+_[^~]++~[._a-zA-Z\d]{7}$/', $id) || $definition->isDeprecated() || !$reflectionClass = $this->container->getReflectionClass($definition->getClass(), false)) {
  354.             return;
  355.         }
  357.         foreach ($reflectionClass->getInterfaces() as $reflectionInterface) {
  358.             $this->set($reflectionInterface->name, $id);
  359.         }
  361.         do {
  362.             $this->set($reflectionClass->name, $id);
  363.         } while ($reflectionClass = $reflectionClass->getParentClass());
  364.     }
  366.     /**
  367.      * Associates a type and a service id if applicable.
  368.      *
  369.      * @param string $type
  370.      * @param string $id
  371.      */
  372.     private function set($type, $id)
  373.     {
  374.         if (isset($this->definedTypes[$type])) {
  375.             return;
  376.         }
  378.         // is this already a type/class that is known to match multiple services?
  379.         if (isset($this->ambiguousServiceTypes[$type])) {
  380.             $this->ambiguousServiceTypes[$type][] = $id;
  382.             return;
  383.         }
  385.         // check to make sure the type doesn't match multiple services
  386.         if (!isset($this->types[$type]) || $this->types[$type] === $id) {
  387.             $this->types[$type] = $id;
  389.             return;
  390.         }
  392.         // keep an array of all services matching this type
  393.         if (!isset($this->ambiguousServiceTypes[$type])) {
  394.             $this->ambiguousServiceTypes[$type] = array($this->types[$type]);
  395.             unset($this->types[$type]);
  396.         }
  397.         $this->ambiguousServiceTypes[$type][] = $id;
  398.     }
  400.     /**
  401.      * Registers a definition for the type if possible or throws an exception.
  402.      *
  403.      * @param string $type
  404.      *
  405.      * @return TypedReference|null A reference to the registered definition
  406.      */
  407.     private function createAutowiredDefinition($type)
  408.     {
  409.         if (!($typeHint = $this->container->getReflectionClass($type, false)) || !$typeHint->isInstantiable()) {
  410.             return;
  411.         }
  413.         $currentId = $this->currentId;
  414.         $this->currentId = $type;
  415.         $this->autowired[$type] = $argumentId = sprintf('autowired.%s', $type);
  416.         $argumentDefinition = new Definition($type);
  417.         $argumentDefinition->setPublic(false);
  418.         $argumentDefinition->setAutowired(true);
  420.         try {
  421.             $originalThrowSetting = $this->throwOnAutowiringException;
  422.             $this->throwOnAutowiringException = true;
  423.             $this->processValue($argumentDefinition, true);
  424.             $this->container->setDefinition($argumentId, $argumentDefinition);
  425.         } catch (AutowiringFailedException $e) {
  426.             $this->autowired[$type] = false;
  427.             $this->lastFailure = $e->getMessage();
  428.             $this->container->log($this, $this->lastFailure);
  430.             return;
  431.         } finally {
  432.             $this->throwOnAutowiringException = $originalThrowSetting;
  433.             $this->currentId = $currentId;
  434.         }
  436.         @trigger_error(sprintf('Relying on service auto-registration for type "%s" is deprecated since Symfony 3.4 and won\'t be supported in 4.0. Create a service named "%s" instead.', $type, $type), E_USER_DEPRECATED);
  438.         $this->container->log($this, sprintf('Type "%s" has been auto-registered for service "%s".', $type, $this->currentId));
  440.         return new TypedReference($argumentId, $type);
  441.     }
  443.     private function createTypeNotFoundMessage(TypedReference $reference, $label)
  444.     {
  445.         if (!$r = $this->container->getReflectionClass($type = $reference->getType(), false)) {
  446.             // either $type does not exist or a parent class does not exist
  447.             try {
  448.                 $resource = new ClassExistenceResource($type, false);
  449.                 // isFresh() will explode ONLY if a parent class/trait does not exist
  450.                 $resource->isFresh(0);
  451.                 $parentMsg = false;
  452.             } catch (\ReflectionException $e) {
  453.                 $parentMsg = $e->getMessage();
  454.             }
  456.             $message = sprintf('has type "%s" but this class %s.', $type, $parentMsg ? sprintf('is missing a parent class (%s)', $parentMsg) : 'was not found');
  457.         } else {
  458.             $message = $this->container->has($type) ? 'this service is abstract' : 'no such service exists';
  459.             $message = sprintf('references %s "%s" but %s.%s', $r->isInterface() ? 'interface' : 'class', $type, $message, $this->createTypeAlternatives($reference));
  461.             if ($r->isInterface()) {
  462.                 $message .= ' Did you create a class that implements this interface?';
  463.             }
  464.         }
  466.         $message = sprintf('Cannot autowire service "%s": %s %s', $this->currentId, $label, $message);
  468.         if (null !== $this->lastFailure) {
  469.             $message = $this->lastFailure."\n".$message;
  470.             $this->lastFailure = null;
  471.         }
  473.         return $message;
  474.     }
  476.     private function createTypeAlternatives(TypedReference $reference)
  477.     {
  478.         // try suggesting available aliases first
  479.         if ($message = $this->getAliasesSuggestionForType($type = $reference->getType())) {
  480.             return ' '.$message;
  481.         }
  483.         if (isset($this->ambiguousServiceTypes[$type])) {
  484.             $message = sprintf('one of these existing services: "%s"', implode('", "', $this->ambiguousServiceTypes[$type]));
  485.         } elseif (isset($this->types[$type])) {
  486.             $message = sprintf('the existing "%s" service', $this->types[$type]);
  487.         } elseif ($reference->getRequiringClass() && !$reference->canBeAutoregistered()) {
  488.             return ' It cannot be auto-registered because it is from a different root namespace.';
  489.         } else {
  490.             return;
  491.         }
  493.         return sprintf(' You should maybe alias this %s to %s.', class_exists($type, false) ? 'class' : 'interface', $message);
  494.     }
  496.     /**
  497.      * @deprecated since version 3.3, to be removed in 4.0.
  498.      */
  499.     private static function getResourceMetadataForMethod(\ReflectionMethod $method)
  500.     {
  501.         $methodArgumentsMetadata = array();
  502.         foreach ($method->getParameters() as $parameter) {
  503.             try {
  504.                 $class = $parameter->getClass();
  505.             } catch (\ReflectionException $e) {
  506.                 // type-hint is against a non-existent class
  507.                 $class = false;
  508.             }
  510.             $isVariadic = method_exists($parameter, 'isVariadic') && $parameter->isVariadic();
  511.             $methodArgumentsMetadata[] = array(
  512.                 'class' => $class,
  513.                 'isOptional' => $parameter->isOptional(),
  514.                 'defaultValue' => ($parameter->isOptional() && !$isVariadic) ? $parameter->getDefaultValue() : null,
  515.             );
  516.         }
  518.         return $methodArgumentsMetadata;
  519.     }
  521.     private function getAliasesSuggestionForType($type, $extraContext = null)
  522.     {
  523.         $aliases = array();
  524.         foreach (class_parents($type) + class_implements($type) as $parent) {
  525.             if ($this->container->has($parent) && !$this->container->findDefinition($parent)->isAbstract()) {
  526.                 $aliases[] = $parent;
  527.             }
  528.         }
  530.         $extraContext = $extraContext ? ' '.$extraContext : '';
  531.         if (1 < $len = count($aliases)) {
  532.             $message = sprintf('Try changing the type-hint%s to one of its parents: ', $extraContext);
  533.             for ($i = 0, --$len; $i < $len; ++$i) {
  534.                 $message .= sprintf('%s "%s", ', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
  535.             }
  536.             $message .= sprintf('or %s "%s".', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
  538.             return $message;
  539.         }
  541.         if ($aliases) {
  542.             return sprintf('Try changing the type-hint%s to "%s" instead.', $extraContext, $aliases[0]);
  543.         }
  544.     }
  545. }