123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475 |
- <?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\Config\Resource\ClassExistenceResource;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Definition;
- use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
- use Symfony\Component\DependencyInjection\Exception\RuntimeException;
- use Symfony\Component\DependencyInjection\LazyProxy\ProxyHelper;
- use Symfony\Component\DependencyInjection\TypedReference;
- /**
- * Inspects existing service definitions and wires the autowired ones using the type hints of their classes.
- *
- * @author Kévin Dunglas <dunglas@gmail.com>
- * @author Nicolas Grekas <p@tchwork.com>
- */
- class AutowirePass extends AbstractRecursivePass
- {
- private $types;
- private $ambiguousServiceTypes;
- private $lastFailure;
- private $throwOnAutowiringException;
- private $decoratedClass;
- private $decoratedId;
- private $methodCalls;
- private $getPreviousValue;
- private $decoratedMethodIndex;
- private $decoratedMethodArgumentIndex;
- private $typesClone;
- public function __construct(bool $throwOnAutowireException = true)
- {
- $this->throwOnAutowiringException = $throwOnAutowireException;
- }
- /**
- * {@inheritdoc}
- */
- public function process(ContainerBuilder $container)
- {
- try {
- $this->typesClone = clone $this;
- parent::process($container);
- } finally {
- $this->decoratedClass = null;
- $this->decoratedId = null;
- $this->methodCalls = null;
- $this->getPreviousValue = null;
- $this->decoratedMethodIndex = null;
- $this->decoratedMethodArgumentIndex = null;
- $this->typesClone = null;
- }
- }
- /**
- * {@inheritdoc}
- */
- protected function processValue($value, bool $isRoot = false)
- {
- try {
- return $this->doProcessValue($value, $isRoot);
- } catch (AutowiringFailedException $e) {
- if ($this->throwOnAutowiringException) {
- throw $e;
- }
- $this->container->getDefinition($this->currentId)->addError($e->getMessageCallback() ?? $e->getMessage());
- return parent::processValue($value, $isRoot);
- }
- }
- /**
- * @return mixed
- */
- private function doProcessValue($value, bool $isRoot = false)
- {
- if ($value instanceof TypedReference) {
- if ($ref = $this->getAutowiredReference($value)) {
- return $ref;
- }
- if (ContainerBuilder::RUNTIME_EXCEPTION_ON_INVALID_REFERENCE === $value->getInvalidBehavior()) {
- $message = $this->createTypeNotFoundMessageCallback($value, 'it');
- // since the error message varies by referenced id and $this->currentId, so should the id of the dummy errored definition
- $this->container->register($id = sprintf('.errored.%s.%s', $this->currentId, (string) $value), $value->getType())
- ->addError($message);
- return new TypedReference($id, $value->getType(), $value->getInvalidBehavior(), $value->getName());
- }
- }
- $value = parent::processValue($value, $isRoot);
- if (!$value instanceof Definition || !$value->isAutowired() || $value->isAbstract() || !$value->getClass()) {
- return $value;
- }
- if (!$reflectionClass = $this->container->getReflectionClass($value->getClass(), false)) {
- $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" cannot be loaded.', $this->currentId, $value->getClass()));
- return $value;
- }
- $this->methodCalls = $value->getMethodCalls();
- try {
- $constructor = $this->getConstructor($value, false);
- } catch (RuntimeException $e) {
- throw new AutowiringFailedException($this->currentId, $e->getMessage(), 0, $e);
- }
- if ($constructor) {
- array_unshift($this->methodCalls, [$constructor, $value->getArguments()]);
- }
- $this->methodCalls = $this->autowireCalls($reflectionClass, $isRoot);
- if ($constructor) {
- [, $arguments] = array_shift($this->methodCalls);
- if ($arguments !== $value->getArguments()) {
- $value->setArguments($arguments);
- }
- }
- if ($this->methodCalls !== $value->getMethodCalls()) {
- $value->setMethodCalls($this->methodCalls);
- }
- return $value;
- }
- private function autowireCalls(\ReflectionClass $reflectionClass, bool $isRoot): array
- {
- $this->decoratedId = null;
- $this->decoratedClass = null;
- $this->getPreviousValue = null;
- if ($isRoot && ($definition = $this->container->getDefinition($this->currentId)) && null !== ($this->decoratedId = $definition->innerServiceId) && $this->container->has($this->decoratedId)) {
- $this->decoratedClass = $this->container->findDefinition($this->decoratedId)->getClass();
- }
- foreach ($this->methodCalls as $i => $call) {
- $this->decoratedMethodIndex = $i;
- [$method, $arguments] = $call;
- if ($method instanceof \ReflectionFunctionAbstract) {
- $reflectionMethod = $method;
- } else {
- $definition = new Definition($reflectionClass->name);
- try {
- $reflectionMethod = $this->getReflectionMethod($definition, $method);
- } catch (RuntimeException $e) {
- if ($definition->getFactory()) {
- continue;
- }
- throw $e;
- }
- }
- $arguments = $this->autowireMethod($reflectionMethod, $arguments);
- if ($arguments !== $call[1]) {
- $this->methodCalls[$i][1] = $arguments;
- }
- }
- return $this->methodCalls;
- }
- /**
- * Autowires the constructor or a method.
- *
- * @return array The autowired arguments
- *
- * @throws AutowiringFailedException
- */
- private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, array $arguments): array
- {
- $class = $reflectionMethod instanceof \ReflectionMethod ? $reflectionMethod->class : $this->currentId;
- $method = $reflectionMethod->name;
- $parameters = $reflectionMethod->getParameters();
- if ($reflectionMethod->isVariadic()) {
- array_pop($parameters);
- }
- foreach ($parameters as $index => $parameter) {
- if (\array_key_exists($index, $arguments) && '' !== $arguments[$index]) {
- continue;
- }
- $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);
- if (!$type) {
- if (isset($arguments[$index])) {
- continue;
- }
- // no default value? Then fail
- if (!$parameter->isDefaultValueAvailable()) {
- // For core classes, isDefaultValueAvailable() can
- // be false when isOptional() returns true. If the
- // argument *is* optional, allow it to be missing
- if ($parameter->isOptional()) {
- continue;
- }
- $type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, false);
- $type = $type ? sprintf('is type-hinted "%s"', ltrim($type, '\\')) : 'has no type-hint';
- 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));
- }
- // specifically pass the default value
- $arguments[$index] = $parameter->getDefaultValue();
- continue;
- }
- $getValue = function () use ($type, $parameter, $class, $method) {
- if (!$value = $this->getAutowiredReference($ref = new TypedReference($type, $type, ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE, $parameter->name))) {
- $failureMessage = $this->createTypeNotFoundMessageCallback($ref, sprintf('argument "$%s" of method "%s()"', $parameter->name, $class !== $this->currentId ? $class.'::'.$method : $method));
- if ($parameter->isDefaultValueAvailable()) {
- $value = $parameter->getDefaultValue();
- } elseif (!$parameter->allowsNull()) {
- throw new AutowiringFailedException($this->currentId, $failureMessage);
- }
- }
- return $value;
- };
- if ($this->decoratedClass && $isDecorated = is_a($this->decoratedClass, $type, true)) {
- if ($this->getPreviousValue) {
- // The inner service is injected only if there is only 1 argument matching the type of the decorated class
- // across all arguments of all autowired methods.
- // If a second matching argument is found, the default behavior is restored.
- $getPreviousValue = $this->getPreviousValue;
- $this->methodCalls[$this->decoratedMethodIndex][1][$this->decoratedMethodArgumentIndex] = $getPreviousValue();
- $this->decoratedClass = null; // Prevent further checks
- } else {
- $arguments[$index] = new TypedReference($this->decoratedId, $this->decoratedClass);
- $this->getPreviousValue = $getValue;
- $this->decoratedMethodArgumentIndex = $index;
- continue;
- }
- }
- $arguments[$index] = $getValue();
- }
- if ($parameters && !isset($arguments[++$index])) {
- while (0 <= --$index) {
- $parameter = $parameters[$index];
- if (!$parameter->isDefaultValueAvailable() || $parameter->getDefaultValue() !== $arguments[$index]) {
- break;
- }
- unset($arguments[$index]);
- }
- }
- // it's possible index 1 was set, then index 0, then 2, etc
- // make sure that we re-order so they're injected as expected
- ksort($arguments);
- return $arguments;
- }
- /**
- * Returns a reference to the service matching the given type, if any.
- */
- private function getAutowiredReference(TypedReference $reference): ?TypedReference
- {
- $this->lastFailure = null;
- $type = $reference->getType();
- if ($type !== (string) $reference) {
- return $reference;
- }
- if (null !== $name = $reference->getName()) {
- if ($this->container->has($alias = $type.' $'.$name) && !$this->container->findDefinition($alias)->isAbstract()) {
- return new TypedReference($alias, $type, $reference->getInvalidBehavior());
- }
- if ($this->container->has($name) && !$this->container->findDefinition($name)->isAbstract()) {
- foreach ($this->container->getAliases() as $id => $alias) {
- if ($name === (string) $alias && 0 === strpos($id, $type.' $')) {
- return new TypedReference($name, $type, $reference->getInvalidBehavior());
- }
- }
- }
- }
- if ($this->container->has($type) && !$this->container->findDefinition($type)->isAbstract()) {
- return new TypedReference($type, $type, $reference->getInvalidBehavior());
- }
- return null;
- }
- /**
- * Populates the list of available types.
- */
- private function populateAvailableTypes(ContainerBuilder $container)
- {
- $this->types = [];
- $this->ambiguousServiceTypes = [];
- foreach ($container->getDefinitions() as $id => $definition) {
- $this->populateAvailableType($container, $id, $definition);
- }
- }
- /**
- * Populates the list of available types for a given definition.
- */
- private function populateAvailableType(ContainerBuilder $container, string $id, Definition $definition)
- {
- // Never use abstract services
- if ($definition->isAbstract()) {
- return;
- }
- if ('' === $id || '.' === $id[0] || $definition->isDeprecated() || !$reflectionClass = $container->getReflectionClass($definition->getClass(), false)) {
- return;
- }
- foreach ($reflectionClass->getInterfaces() as $reflectionInterface) {
- $this->set($reflectionInterface->name, $id);
- }
- do {
- $this->set($reflectionClass->name, $id);
- } while ($reflectionClass = $reflectionClass->getParentClass());
- }
- /**
- * Associates a type and a service id if applicable.
- */
- private function set(string $type, string $id)
- {
- // is this already a type/class that is known to match multiple services?
- if (isset($this->ambiguousServiceTypes[$type])) {
- $this->ambiguousServiceTypes[$type][] = $id;
- return;
- }
- // check to make sure the type doesn't match multiple services
- if (!isset($this->types[$type]) || $this->types[$type] === $id) {
- $this->types[$type] = $id;
- return;
- }
- // keep an array of all services matching this type
- if (!isset($this->ambiguousServiceTypes[$type])) {
- $this->ambiguousServiceTypes[$type] = [$this->types[$type]];
- unset($this->types[$type]);
- }
- $this->ambiguousServiceTypes[$type][] = $id;
- }
- private function createTypeNotFoundMessageCallback(TypedReference $reference, string $label): callable
- {
- if (null === $this->typesClone->container) {
- $this->typesClone->container = new ContainerBuilder($this->container->getParameterBag());
- $this->typesClone->container->setAliases($this->container->getAliases());
- $this->typesClone->container->setDefinitions($this->container->getDefinitions());
- $this->typesClone->container->setResourceTracking(false);
- }
- $currentId = $this->currentId;
- return (function () use ($reference, $label, $currentId) {
- return $this->createTypeNotFoundMessage($reference, $label, $currentId);
- })->bindTo($this->typesClone);
- }
- private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId): string
- {
- if (!$r = $this->container->getReflectionClass($type = $reference->getType(), false)) {
- // either $type does not exist or a parent class does not exist
- try {
- $resource = new ClassExistenceResource($type, false);
- // isFresh() will explode ONLY if a parent class/trait does not exist
- $resource->isFresh(0);
- $parentMsg = false;
- } catch (\ReflectionException $e) {
- $parentMsg = $e->getMessage();
- }
- $message = sprintf('has type "%s" but this class %s.', $type, $parentMsg ? sprintf('is missing a parent class (%s)', $parentMsg) : 'was not found');
- } else {
- $alternatives = $this->createTypeAlternatives($this->container, $reference);
- $message = $this->container->has($type) ? 'this service is abstract' : 'no such service exists';
- $message = sprintf('references %s "%s" but %s.%s', $r->isInterface() ? 'interface' : 'class', $type, $message, $alternatives);
- if ($r->isInterface() && !$alternatives) {
- $message .= ' Did you create a class that implements this interface?';
- }
- }
- $message = sprintf('Cannot autowire service "%s": %s %s', $currentId, $label, $message);
- if (null !== $this->lastFailure) {
- $message = $this->lastFailure."\n".$message;
- $this->lastFailure = null;
- }
- return $message;
- }
- private function createTypeAlternatives(ContainerBuilder $container, TypedReference $reference): string
- {
- // try suggesting available aliases first
- if ($message = $this->getAliasesSuggestionForType($container, $type = $reference->getType())) {
- return ' '.$message;
- }
- if (null === $this->ambiguousServiceTypes) {
- $this->populateAvailableTypes($container);
- }
- $servicesAndAliases = $container->getServiceIds();
- if (!$container->has($type) && false !== $key = array_search(strtolower($type), array_map('strtolower', $servicesAndAliases))) {
- return sprintf(' Did you mean "%s"?', $servicesAndAliases[$key]);
- } elseif (isset($this->ambiguousServiceTypes[$type])) {
- $message = sprintf('one of these existing services: "%s"', implode('", "', $this->ambiguousServiceTypes[$type]));
- } elseif (isset($this->types[$type])) {
- $message = sprintf('the existing "%s" service', $this->types[$type]);
- } else {
- return '';
- }
- return sprintf(' You should maybe alias this %s to %s.', class_exists($type, false) ? 'class' : 'interface', $message);
- }
- private function getAliasesSuggestionForType(ContainerBuilder $container, string $type): ?string
- {
- $aliases = [];
- foreach (class_parents($type) + class_implements($type) as $parent) {
- if ($container->has($parent) && !$container->findDefinition($parent)->isAbstract()) {
- $aliases[] = $parent;
- }
- }
- if (1 < $len = \count($aliases)) {
- $message = 'Try changing the type-hint to one of its parents: ';
- for ($i = 0, --$len; $i < $len; ++$i) {
- $message .= sprintf('%s "%s", ', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
- }
- $message .= sprintf('or %s "%s".', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
- return $message;
- }
- if ($aliases) {
- return sprintf('Try changing the type-hint to "%s" instead.', $aliases[0]);
- }
- return null;
- }
- }
|