vendor/symfony/dependency-injection/Compiler/AutowirePass.php line 329

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 = [];
  32.     private $types;
  33.     private $ambiguousServiceTypes;
  34.     private $autowired = [];
  35.     private $lastFailure;
  36.     private $throwOnAutowiringException;
  37.     private $autowiringExceptions = [];
  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 = [];
  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 = [];
  73.             $this->types = null;
  74.             $this->ambiguousServiceTypes = null;
  75.             $this->autowired = [];
  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 = [];
  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, [$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.                 $definition = new Definition($reflectionClass->name);
  185.                 try {
  186.                     $reflectionMethod = $this->getReflectionMethod($definition, $method);
  187.                 } catch (RuntimeException $e) {
  188.                     if ($definition->getFactory()) {
  189.                         continue;
  190.                     }
  191.                     throw $e;
  192.                 }
  193.             }
  195.             $arguments = $this->autowireMethod($reflectionMethod, $arguments);
  197.             if ($arguments !== $call[1]) {
  198.                 $methodCalls[$i][1] = $arguments;
  199.             }
  200.         }
  202.         return $methodCalls;
  203.     }
  205.     /**
  206.      * Autowires the constructor or a method.
  207.      *
  208.      * @param \ReflectionFunctionAbstract $reflectionMethod
  209.      * @param array                       $arguments
  210.      *
  211.      * @return array The autowired arguments
  212.      *
  213.      * @throws AutowiringFailedException
  214.      */
  215.     private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, array $arguments)
  216.     {
  217.         $class = $reflectionMethod instanceof \ReflectionMethod ? $reflectionMethod->class : $this->currentId;
  218.         $method = $reflectionMethod->name;
  219.         $parameters = $reflectionMethod->getParameters();
  220.         if (method_exists('ReflectionMethod', 'isVariadic') && $reflectionMethod->isVariadic()) {
  221.             array_pop($parameters);
  222.         }
  224.         foreach ($parameters as $index => $parameter) {
  225.             if (\array_key_exists($index, $arguments) && '' !== $arguments[$index]) {
  226.                 continue;
  227.             }
  229.             $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);
  231.             if (!$type) {
  232.                 if (isset($arguments[$index])) {
  233.                     continue;
  234.                 }
  236.                 // no default value? Then fail
  237.                 if (!$parameter->isDefaultValueAvailable()) {
  238.                     // For core classes, isDefaultValueAvailable() can
  239.                     // be false when isOptional() returns true. If the
  240.                     // argument *is* optional, allow it to be missing
  241.                     if ($parameter->isOptional()) {
  242.                         continue;
  243.                     }
  244.                     $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, false);
  245.                     $type = $type ? sprintf('is type-hinted "%s"', $type) : 'has no type-hint';
  247.                     throw new AutowiringFailedException($this->currentId, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s()" %s, you should configure its value explicitly.', $this->currentId, $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method, $type));
  248.                 }
  250.                 // specifically pass the default value
  251.                 $arguments[$index] = $parameter->getDefaultValue();
  253.                 continue;
  254.             }
  256.             if (!$value = $this->getAutowiredReference($ref = new TypedReference($type, $type, !$parameter->isOptional() ? $class : ''), 'for '.sprintf('argument "$%s" of method "%s()"', $parameter->name, $class.'::'.$method))) {
  257.                 $failureMessage = $this->createTypeNotFoundMessage($ref, sprintf('argument "$%s" of method "%s()"', $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method));
  259.                 if ($parameter->isDefaultValueAvailable()) {
  260.                     $value = $parameter->getDefaultValue();
  261.                 } elseif (!$parameter->allowsNull()) {
  262.                     throw new AutowiringFailedException($this->currentId, $failureMessage);
  263.                 }
  264.                 $this->container->log($this, $failureMessage);
  265.             }
  267.             $arguments[$index] = $value;
  268.         }
  270.         if ($parameters && !isset($arguments[++$index])) {
  271.             while (0 <= --$index) {
  272.                 $parameter = $parameters[$index];
  273.                 if (!$parameter->isDefaultValueAvailable() || $parameter->getDefaultValue() !== $arguments[$index]) {
  274.                     break;
  275.                 }
  276.                 unset($arguments[$index]);
  277.             }
  278.         }
  280.         // it's possible index 1 was set, then index 0, then 2, etc
  281.         // make sure that we re-order so they're injected as expected
  282.         ksort($arguments);
  284.         return $arguments;
  285.     }
  287.     /**
  288.      * @return TypedReference|null A reference to the service matching the given type, if any
  289.      */
  290.     private function getAutowiredReference(TypedReference $reference, $deprecationMessage)
  291.     {
  292.         $this->lastFailure = null;
  293.         $type = $reference->getType();
  295.         if ($type !== $this->container->normalizeId($reference) || ($this->container->has($type) && !$this->container->findDefinition($type)->isAbstract())) {
  296.             return $reference;
  297.         }
  299.         if (null === $this->types) {
  300.             $this->populateAvailableTypes($this->strictMode);
  301.         }
  303.         if (isset($this->definedTypes[$type])) {
  304.             return new TypedReference($this->types[$type], $type);
  305.         }
  307.         if (!$this->strictMode && isset($this->types[$type])) {
  308.             $message = 'Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won\'t be supported in version 4.0.';
  309.             if ($aliasSuggestion = $this->getAliasesSuggestionForType($type = $reference->getType(), $deprecationMessage)) {
  310.                 $message .= ' '.$aliasSuggestion;
  311.             } else {
  312.                 $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);
  313.             }
  315.             @trigger_error($message, E_USER_DEPRECATED);
  317.             return new TypedReference($this->types[$type], $type);
  318.         }
  320.         if (!$reference->canBeAutoregistered() || isset($this->types[$type]) || isset($this->ambiguousServiceTypes[$type])) {
  321.             return;
  322.         }
  324.         if (isset($this->autowired[$type])) {
  325.             return $this->autowired[$type] ? new TypedReference($this->autowired[$type], $type) : null;
  326.         }
  328.         if (!$this->strictMode) {
  329.             return $this->createAutowiredDefinition($type);
  330.         }
  331.     }
  333.     /**
  334.      * Populates the list of available types.
  335.      */
  336.     private function populateAvailableTypes($onlyAutowiringTypes = false)
  337.     {
  338.         $this->types = [];
  339.         if (!$onlyAutowiringTypes) {
  340.             $this->ambiguousServiceTypes = [];
  341.         }
  343.         foreach ($this->container->getDefinitions() as $id => $definition) {
  344.             $this->populateAvailableType($id, $definition, $onlyAutowiringTypes);
  345.         }
  346.     }
  348.     /**
  349.      * Populates the list of available types for a given definition.
  350.      *
  351.      * @param string     $id
  352.      * @param Definition $definition
  353.      */
  354.     private function populateAvailableType($id, Definition $definition, $onlyAutowiringTypes)
  355.     {
  356.         // Never use abstract services
  357.         if ($definition->isAbstract()) {
  358.             return;
  359.         }
  361.         foreach ($definition->getAutowiringTypes(false) as $type) {
  362.             $this->definedTypes[$type] = true;
  363.             $this->types[$type] = $id;
  364.             unset($this->ambiguousServiceTypes[$type]);
  365.         }
  367.         if ($onlyAutowiringTypes) {
  368.             return;
  369.         }
  371.         if (preg_match('/^\d+_[^~]++~[._a-zA-Z\d]{7}$/', $id) || $definition->isDeprecated() || !$reflectionClass = $this->container->getReflectionClass($definition->getClass(), false)) {
  372.             return;
  373.         }
  375.         foreach ($reflectionClass->getInterfaces() as $reflectionInterface) {
  376.             $this->set($reflectionInterface->name, $id);
  377.         }
  379.         do {
  380.             $this->set($reflectionClass->name, $id);
  381.         } while ($reflectionClass = $reflectionClass->getParentClass());
  382.     }
  384.     /**
  385.      * Associates a type and a service id if applicable.
  386.      *
  387.      * @param string $type
  388.      * @param string $id
  389.      */
  390.     private function set($type, $id)
  391.     {
  392.         if (isset($this->definedTypes[$type])) {
  393.             return;
  394.         }
  396.         // is this already a type/class that is known to match multiple services?
  397.         if (isset($this->ambiguousServiceTypes[$type])) {
  398.             $this->ambiguousServiceTypes[$type][] = $id;
  400.             return;
  401.         }
  403.         // check to make sure the type doesn't match multiple services
  404.         if (!isset($this->types[$type]) || $this->types[$type] === $id) {
  405.             $this->types[$type] = $id;
  407.             return;
  408.         }
  410.         // keep an array of all services matching this type
  411.         if (!isset($this->ambiguousServiceTypes[$type])) {
  412.             $this->ambiguousServiceTypes[$type] = [$this->types[$type]];
  413.             unset($this->types[$type]);
  414.         }
  415.         $this->ambiguousServiceTypes[$type][] = $id;
  416.     }
  418.     /**
  419.      * Registers a definition for the type if possible or throws an exception.
  420.      *
  421.      * @param string $type
  422.      *
  423.      * @return TypedReference|null A reference to the registered definition
  424.      */
  425.     private function createAutowiredDefinition($type)
  426.     {
  427.         if (!($typeHint = $this->container->getReflectionClass($type, false)) || !$typeHint->isInstantiable()) {
  428.             return;
  429.         }
  431.         $currentId = $this->currentId;
  432.         $this->currentId = $type;
  433.         $this->autowired[$type] = $argumentId = sprintf('autowired.%s', $type);
  434.         $argumentDefinition = new Definition($type);
  435.         $argumentDefinition->setPublic(false);
  436.         $argumentDefinition->setAutowired(true);
  438.         try {
  439.             $originalThrowSetting = $this->throwOnAutowiringException;
  440.             $this->throwOnAutowiringException = true;
  441.             $this->processValue($argumentDefinition, true);
  442.             $this->container->setDefinition($argumentId, $argumentDefinition);
  443.         } catch (AutowiringFailedException $e) {
  444.             $this->autowired[$type] = false;
  445.             $this->lastFailure = $e->getMessage();
  446.             $this->container->log($this, $this->lastFailure);
  448.             return;
  449.         } finally {
  450.             $this->throwOnAutowiringException = $originalThrowSetting;
  451.             $this->currentId = $currentId;
  452.         }
  454.         @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);
  456.         $this->container->log($this, sprintf('Type "%s" has been auto-registered for service "%s".', $type, $this->currentId));
  458.         return new TypedReference($argumentId, $type);
  459.     }
  461.     private function createTypeNotFoundMessage(TypedReference $reference, $label)
  462.     {
  463.         $trackResources = $this->container->isTrackingResources();
  464.         $this->container->setResourceTracking(false);
  465.         try {
  466.             if ($r = $this->container->getReflectionClass($type = $reference->getType(), false)) {
  467.                 $alternatives = $this->createTypeAlternatives($reference);
  468.             }
  469.         } finally {
  470.             $this->container->setResourceTracking($trackResources);
  471.         }
  473.         if (!$r) {
  474.             // either $type does not exist or a parent class does not exist
  475.             try {
  476.                 $resource = new ClassExistenceResource($type, false);
  477.                 // isFresh() will explode ONLY if a parent class/trait does not exist
  478.                 $resource->isFresh(0);
  479.                 $parentMsg = false;
  480.             } catch (\ReflectionException $e) {
  481.                 $parentMsg = $e->getMessage();
  482.             }
  484.             $message = sprintf('has type "%s" but this class %s.', $type, $parentMsg ? sprintf('is missing a parent class (%s)', $parentMsg) : 'was not found');
  485.         } else {
  486.             $message = $this->container->has($type) ? 'this service is abstract' : 'no such service exists';
  487.             $message = sprintf('references %s "%s" but %s.%s', $r->isInterface() ? 'interface' : 'class', $type, $message, $alternatives);
  489.             if ($r->isInterface() && !$alternatives) {
  490.                 $message .= ' Did you create a class that implements this interface?';
  491.             }
  492.         }
  494.         $message = sprintf('Cannot autowire service "%s": %s %s', $this->currentId, $label, $message);
  496.         if (null !== $this->lastFailure) {
  497.             $message = $this->lastFailure."\n".$message;
  498.             $this->lastFailure = null;
  499.         }
  501.         return $message;
  502.     }
  504.     private function createTypeAlternatives(TypedReference $reference)
  505.     {
  506.         // try suggesting available aliases first
  507.         if ($message = $this->getAliasesSuggestionForType($type = $reference->getType())) {
  508.             return ' '.$message;
  509.         }
  510.         if (null === $this->ambiguousServiceTypes) {
  511.             $this->populateAvailableTypes();
  512.         }
  514.         if (isset($this->ambiguousServiceTypes[$type])) {
  515.             $message = sprintf('one of these existing services: "%s"', implode('", "', $this->ambiguousServiceTypes[$type]));
  516.         } elseif (isset($this->types[$type])) {
  517.             $message = sprintf('the existing "%s" service', $this->types[$type]);
  518.         } elseif ($reference->getRequiringClass() && !$reference->canBeAutoregistered() && !$this->strictMode) {
  519.             return ' It cannot be auto-registered because it is from a different root namespace.';
  520.         } else {
  521.             return;
  522.         }
  524.         return sprintf(' You should maybe alias this %s to %s.', class_exists($type, false) ? 'class' : 'interface', $message);
  525.     }
  527.     /**
  528.      * @deprecated since version 3.3, to be removed in 4.0.
  529.      */
  530.     private static function getResourceMetadataForMethod(\ReflectionMethod $method)
  531.     {
  532.         $methodArgumentsMetadata = [];
  533.         foreach ($method->getParameters() as $parameter) {
  534.             try {
  535.                 $class = $parameter->getClass();
  536.             } catch (\ReflectionException $e) {
  537.                 // type-hint is against a non-existent class
  538.                 $class = false;
  539.             }
  541.             $isVariadic = method_exists($parameter, 'isVariadic') && $parameter->isVariadic();
  542.             $methodArgumentsMetadata[] = [
  543.                 'class' => $class,
  544.                 'isOptional' => $parameter->isOptional(),
  545.                 'defaultValue' => ($parameter->isOptional() && !$isVariadic) ? $parameter->getDefaultValue() : null,
  546.             ];
  547.         }
  549.         return $methodArgumentsMetadata;
  550.     }
  552.     private function getAliasesSuggestionForType($type, $extraContext = null)
  553.     {
  554.         $aliases = [];
  555.         foreach (class_parents($type) + class_implements($type) as $parent) {
  556.             if ($this->container->has($parent) && !$this->container->findDefinition($parent)->isAbstract()) {
  557.                 $aliases[] = $parent;
  558.             }
  559.         }
  561.         $extraContext = $extraContext ? ' '.$extraContext : '';
  562.         if (1 < $len = \count($aliases)) {
  563.             $message = sprintf('Try changing the type-hint%s to one of its parents: ', $extraContext);
  564.             for ($i = 0, --$len; $i < $len; ++$i) {
  565.                 $message .= sprintf('%s "%s", ', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
  566.             }
  567.             $message .= sprintf('or %s "%s".', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
  569.             return $message;
  570.         }
  572.         if ($aliases) {
  573.             return sprintf('Try changing the type-hint%s to "%s" instead.', $extraContext, $aliases[0]);
  574.         }
  575.     }
  576. }