762 lines
32 KiB
PHP
762 lines
32 KiB
PHP
<?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\Attribute\Autowire;
|
|
use Symfony\Component\DependencyInjection\Attribute\AutowireDecorated;
|
|
use Symfony\Component\DependencyInjection\Attribute\AutowireInline;
|
|
use Symfony\Component\DependencyInjection\Attribute\Lazy;
|
|
use Symfony\Component\DependencyInjection\Attribute\Target;
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\Definition;
|
|
use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
|
|
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
|
|
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
|
|
use Symfony\Component\DependencyInjection\Reference;
|
|
use Symfony\Component\DependencyInjection\TypedReference;
|
|
use Symfony\Component\VarExporter\ProxyHelper;
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
protected bool $skipScalars = true;
|
|
|
|
private array $types;
|
|
private array $ambiguousServiceTypes;
|
|
private array $autowiringAliases;
|
|
private ?string $lastFailure = null;
|
|
private ?string $decoratedClass = null;
|
|
private ?string $decoratedId = null;
|
|
private object $defaultArgument;
|
|
private ?\Closure $restorePreviousValue = null;
|
|
private ?self $typesClone = null;
|
|
|
|
public function __construct(
|
|
private bool $throwOnAutowiringException = true,
|
|
) {
|
|
$this->defaultArgument = new class {
|
|
public $value;
|
|
public $names;
|
|
public $bag;
|
|
|
|
public function withValue(\ReflectionParameter $parameter): self
|
|
{
|
|
$clone = clone $this;
|
|
$clone->value = $this->bag->escapeValue($parameter->getDefaultValue());
|
|
|
|
return $clone;
|
|
}
|
|
};
|
|
}
|
|
|
|
public function process(ContainerBuilder $container): void
|
|
{
|
|
$this->defaultArgument->bag = $container->getParameterBag();
|
|
|
|
try {
|
|
$this->typesClone = clone $this;
|
|
parent::process($container);
|
|
} finally {
|
|
$this->decoratedClass = null;
|
|
$this->decoratedId = null;
|
|
$this->defaultArgument->bag = null;
|
|
$this->defaultArgument->names = null;
|
|
$this->restorePreviousValue = null;
|
|
$this->typesClone = null;
|
|
}
|
|
}
|
|
|
|
protected function processValue(mixed $value, bool $isRoot = false): mixed
|
|
{
|
|
if ($value instanceof Autowire) {
|
|
return $this->processValue($this->container->getParameterBag()->resolveValue($value->value));
|
|
}
|
|
|
|
if ($value instanceof AutowireDecorated) {
|
|
$definition = $this->container->getDefinition($this->currentId);
|
|
|
|
return new Reference($definition->innerServiceId ?? $this->currentId.'.inner', $definition->decorationOnInvalid ?? ContainerInterface::NULL_ON_INVALID_REFERENCE);
|
|
}
|
|
|
|
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);
|
|
}
|
|
}
|
|
|
|
private function doProcessValue(mixed $value, bool $isRoot = false): mixed
|
|
{
|
|
if ($value instanceof TypedReference) {
|
|
foreach ($value->getAttributes() as $attribute) {
|
|
if ($attribute === $v = $this->processValue($attribute)) {
|
|
continue;
|
|
}
|
|
if (!$attribute instanceof Autowire || !$v instanceof Reference) {
|
|
return $v;
|
|
}
|
|
|
|
$invalidBehavior = ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE !== $v->getInvalidBehavior() ? $v->getInvalidBehavior() : $value->getInvalidBehavior();
|
|
$value = $v instanceof TypedReference
|
|
? new TypedReference($v, $v->getType(), $invalidBehavior, $v->getName() ?? $value->getName(), array_merge($v->getAttributes(), $value->getAttributes()))
|
|
: new TypedReference($v, $value->getType(), $invalidBehavior, $value->getName(), $value->getAttributes());
|
|
break;
|
|
}
|
|
if ($ref = $this->getAutowiredReference($value, true)) {
|
|
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;
|
|
}
|
|
|
|
$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($methodCalls, [$constructor, $value->getArguments()]);
|
|
}
|
|
|
|
$checkAttributes = !$value->hasTag('container.ignore_attributes');
|
|
$methodCalls = $this->autowireCalls($methodCalls, $reflectionClass, $isRoot, $checkAttributes);
|
|
|
|
if ($constructor) {
|
|
[, $arguments] = array_shift($methodCalls);
|
|
|
|
if ($arguments !== $value->getArguments()) {
|
|
$value->setArguments($arguments);
|
|
}
|
|
}
|
|
|
|
if ($methodCalls !== $value->getMethodCalls()) {
|
|
$value->setMethodCalls($methodCalls);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
private function autowireCalls(array $methodCalls, \ReflectionClass $reflectionClass, bool $isRoot, bool $checkAttributes): array
|
|
{
|
|
if ($isRoot) {
|
|
$this->decoratedId = null;
|
|
$this->decoratedClass = null;
|
|
$this->restorePreviousValue = null;
|
|
|
|
if (($definition = $this->container->getDefinition($this->currentId)) && null !== ($this->decoratedId = $definition->innerServiceId) && $this->container->has($this->decoratedId)) {
|
|
$this->decoratedClass = $this->container->findDefinition($this->decoratedId)->getClass();
|
|
}
|
|
}
|
|
|
|
$patchedIndexes = [];
|
|
|
|
foreach ($methodCalls as $i => $call) {
|
|
[$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, $checkAttributes);
|
|
|
|
if ($arguments !== $call[1]) {
|
|
$methodCalls[$i][1] = $arguments;
|
|
$patchedIndexes[] = $i;
|
|
}
|
|
}
|
|
|
|
// use named arguments to skip complex default values
|
|
foreach ($patchedIndexes as $i) {
|
|
$namedArguments = null;
|
|
$arguments = $methodCalls[$i][1];
|
|
|
|
foreach ($arguments as $j => $value) {
|
|
if ($namedArguments && !$value instanceof $this->defaultArgument) {
|
|
unset($arguments[$j]);
|
|
$arguments[$namedArguments[$j]] = $value;
|
|
}
|
|
if (!$value instanceof $this->defaultArgument) {
|
|
continue;
|
|
}
|
|
|
|
if (\is_array($value->value) ? $value->value : \is_object($value->value)) {
|
|
unset($arguments[$j]);
|
|
$namedArguments = $value->names;
|
|
}
|
|
|
|
if ($namedArguments) {
|
|
unset($arguments[$j]);
|
|
} else {
|
|
$arguments[$j] = $value->value;
|
|
}
|
|
}
|
|
|
|
$methodCalls[$i][1] = $arguments;
|
|
}
|
|
|
|
return $methodCalls;
|
|
}
|
|
|
|
/**
|
|
* Autowires the constructor or a method.
|
|
*
|
|
* @throws AutowiringFailedException
|
|
*/
|
|
private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, array $arguments, bool $checkAttributes): array
|
|
{
|
|
$class = $reflectionMethod instanceof \ReflectionMethod ? $reflectionMethod->class : $this->currentId;
|
|
$method = $reflectionMethod->name;
|
|
$parameters = $reflectionMethod->getParameters();
|
|
if ($reflectionMethod->isVariadic()) {
|
|
array_pop($parameters);
|
|
}
|
|
$defaultArgument = clone $this->defaultArgument;
|
|
$defaultArgument->names = new \ArrayObject();
|
|
|
|
foreach ($parameters as $index => $parameter) {
|
|
$defaultArgument->names[$index] = $parameter->name;
|
|
|
|
if (\array_key_exists($parameter->name, $arguments)) {
|
|
$arguments[$index] = $arguments[$parameter->name];
|
|
unset($arguments[$parameter->name]);
|
|
}
|
|
if (\array_key_exists($index, $arguments) && '' !== $arguments[$index]) {
|
|
continue;
|
|
}
|
|
|
|
$type = ProxyHelper::exportType($parameter, true);
|
|
$target = null;
|
|
$name = Target::parseName($parameter, $target);
|
|
$target = $target ? [$target] : [];
|
|
$currentId = $this->currentId;
|
|
|
|
$getValue = function () use ($type, $parameter, $class, $method, $name, $target, $defaultArgument, $currentId) {
|
|
if (!$value = $this->getAutowiredReference($ref = new TypedReference($type, $type, ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE, $name, $target), false)) {
|
|
$failureMessage = $this->createTypeNotFoundMessageCallback($ref, \sprintf('argument "$%s" of method "%s()"', $parameter->name, $class !== $currentId ? $class.'::'.$method : $method));
|
|
|
|
if ($parameter->isDefaultValueAvailable()) {
|
|
$value = $defaultArgument->withValue($parameter);
|
|
} elseif (!$parameter->allowsNull()) {
|
|
throw new AutowiringFailedException($currentId, $failureMessage);
|
|
}
|
|
}
|
|
|
|
return $value;
|
|
};
|
|
|
|
if ($checkAttributes) {
|
|
$attributes = array_merge($parameter->getAttributes(Autowire::class, \ReflectionAttribute::IS_INSTANCEOF), $parameter->getAttributes(Lazy::class, \ReflectionAttribute::IS_INSTANCEOF));
|
|
|
|
if (1 < \count($attributes)) {
|
|
throw new AutowiringFailedException($this->currentId, 'Using both attributes #[Lazy] and #[Autowire] on an argument is not allowed; use the "lazy" parameter of #[Autowire] instead.');
|
|
}
|
|
|
|
foreach ($attributes as $attribute) {
|
|
$attribute = $attribute->newInstance();
|
|
$value = $attribute instanceof Autowire ? $attribute->value : null;
|
|
|
|
if (\is_string($value) && str_starts_with($value, '%env(') && str_ends_with($value, ')%')) {
|
|
if ($parameter->getType() instanceof \ReflectionNamedType && 'bool' === $parameter->getType()->getName() && !str_starts_with($value, '%env(bool:')) {
|
|
$attribute = new Autowire(substr_replace($value, 'bool:', 5, 0));
|
|
}
|
|
if ($parameter->isDefaultValueAvailable() && $parameter->allowsNull() && null === $parameter->getDefaultValue() && !preg_match('/(^|:)default:/', $value)) {
|
|
$attribute = new Autowire(substr_replace($value, 'default::', 5, 0));
|
|
}
|
|
}
|
|
|
|
$invalidBehavior = $parameter->allowsNull() ? ContainerInterface::NULL_ON_INVALID_REFERENCE : ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE;
|
|
|
|
try {
|
|
$value = $this->processValue(new TypedReference($type ?: '?', $type ?: 'mixed', $invalidBehavior, $name, [$attribute, ...$target]));
|
|
} catch (ParameterNotFoundException $e) {
|
|
if (!$parameter->isDefaultValueAvailable()) {
|
|
throw new AutowiringFailedException($this->currentId, $e->getMessage(), 0, $e);
|
|
}
|
|
$arguments[$index] = clone $defaultArgument;
|
|
$arguments[$index]->value = $parameter->getDefaultValue();
|
|
|
|
continue 2;
|
|
}
|
|
|
|
if ($attribute instanceof AutowireInline) {
|
|
$value = $attribute->buildDefinition($value, $type, $parameter);
|
|
$value = $this->doProcessValue($value);
|
|
} elseif ($lazy = $attribute->lazy) {
|
|
$value ??= $getValue();
|
|
if ($this->container->has($value->getType())) {
|
|
$type = $this->container->findDefinition($value->getType())->getClass();
|
|
}
|
|
$definition = (new Definition($type))
|
|
->setFactory('current')
|
|
->setArguments([[$value]])
|
|
->setLazy(true);
|
|
|
|
if (!\is_array($lazy)) {
|
|
if (str_contains($type, '|')) {
|
|
throw new AutowiringFailedException($this->currentId, \sprintf('Cannot use #[Autowire] with option "lazy: true" on union types for service "%s"; set the option to the interface(s) that should be proxied instead.', $this->currentId));
|
|
}
|
|
$lazy = str_contains($type, '&') ? explode('&', $type) : [];
|
|
}
|
|
|
|
if ($lazy) {
|
|
if (!class_exists($type) && !interface_exists($type, false)) {
|
|
$definition->setClass('object');
|
|
}
|
|
foreach ($lazy as $v) {
|
|
$definition->addTag('proxy', ['interface' => $v]);
|
|
}
|
|
}
|
|
|
|
if ($definition->getClass() !== (string) $value || $definition->getTag('proxy')) {
|
|
$value .= '.'.$this->container->hash([$definition->getClass(), $definition->getTag('proxy')]);
|
|
}
|
|
$this->container->setDefinition($value = '.lazy.'.$value, $definition);
|
|
$value = new Reference($value);
|
|
}
|
|
$arguments[$index] = $value;
|
|
|
|
continue 2;
|
|
}
|
|
|
|
foreach ($parameter->getAttributes(AutowireDecorated::class) as $attribute) {
|
|
$arguments[$index] = $this->processValue($attribute->newInstance());
|
|
|
|
continue 2;
|
|
}
|
|
}
|
|
|
|
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()) {
|
|
--$index;
|
|
break;
|
|
}
|
|
$type = ProxyHelper::exportType($parameter);
|
|
$type = $type ? \sprintf('is type-hinted "%s"', preg_replace('/(^|[(|&])\\\\|^\?\\\\?/', '\1', $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] = $defaultArgument->withValue($parameter);
|
|
|
|
continue;
|
|
}
|
|
|
|
if ($this->decoratedClass && is_a($this->decoratedClass, $type, true)) {
|
|
if ($this->restorePreviousValue) {
|
|
// 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.
|
|
($this->restorePreviousValue)();
|
|
$this->decoratedClass = $this->restorePreviousValue = null; // Prevent further checks
|
|
} else {
|
|
$arguments[$index] = new TypedReference($this->decoratedId, $this->decoratedClass);
|
|
$argumentAtIndex = &$arguments[$index];
|
|
$this->restorePreviousValue = static function () use (&$argumentAtIndex, $getValue) {
|
|
$argumentAtIndex = $getValue();
|
|
};
|
|
|
|
continue;
|
|
}
|
|
}
|
|
|
|
$arguments[$index] = $getValue();
|
|
}
|
|
|
|
if ($parameters && !isset($arguments[++$index])) {
|
|
while (0 <= --$index) {
|
|
if (!$arguments[$index] instanceof $defaultArgument) {
|
|
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, \SORT_NATURAL);
|
|
|
|
return $arguments;
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the service matching the given type, if any.
|
|
*/
|
|
private function getAutowiredReference(TypedReference $reference, bool $filterType): ?TypedReference
|
|
{
|
|
$this->lastFailure = null;
|
|
$type = $reference->getType();
|
|
|
|
if ($type !== (string) $reference) {
|
|
return $reference;
|
|
}
|
|
|
|
if ($filterType && false !== $m = strpbrk($type, '&|')) {
|
|
$types = array_diff(explode($m[0], $type), ['int', 'string', 'array', 'bool', 'float', 'iterable', 'object', 'callable', 'null']);
|
|
|
|
sort($types);
|
|
|
|
$type = implode($m[0], $types);
|
|
}
|
|
|
|
$name = $target = (array_filter($reference->getAttributes(), static fn ($a) => $a instanceof Target)[0] ?? null)?->name;
|
|
|
|
if (null !== $name ??= $reference->getName()) {
|
|
if ($this->container->has($alias = $type.' $'.$name) && $this->canDefinitionBeAutowired($alias)) {
|
|
return new TypedReference($alias, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
if (null !== ($alias = $this->getCombinedAlias($type, $name)) && $this->canDefinitionBeAutowired($alias)) {
|
|
return new TypedReference($alias, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
$parsedName = (new Target($name))->getParsedName();
|
|
|
|
if ($this->container->has($alias = $type.' $'.$parsedName) && $this->canDefinitionBeAutowired($alias)) {
|
|
return new TypedReference($alias, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
if (null !== ($alias = $this->getCombinedAlias($type, $parsedName)) && $this->canDefinitionBeAutowired($alias)) {
|
|
return new TypedReference($alias, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
if (($this->container->has($n = $name) && $this->canDefinitionBeAutowired($n))
|
|
|| ($this->container->has($n = $parsedName) && $this->canDefinitionBeAutowired($n))
|
|
) {
|
|
foreach ($this->container->getAliases() as $id => $alias) {
|
|
if ($n === (string) $alias && str_starts_with($id, $type.' $')) {
|
|
return new TypedReference($n, $type, $reference->getInvalidBehavior());
|
|
}
|
|
}
|
|
}
|
|
|
|
if (null !== $target) {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
if ($this->container->has($type) && $this->canDefinitionBeAutowired($type)) {
|
|
return new TypedReference($type, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
if (null !== ($alias = $this->getCombinedAlias($type)) && $this->canDefinitionBeAutowired($alias)) {
|
|
return new TypedReference($alias, $type, $reference->getInvalidBehavior());
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private function canDefinitionBeAutowired(string $id): bool
|
|
{
|
|
$definition = $this->container->findDefinition($id);
|
|
|
|
return !$definition->isAbstract() && !$definition->hasTag('container.excluded');
|
|
}
|
|
|
|
/**
|
|
* Populates the list of available types.
|
|
*/
|
|
private function populateAvailableTypes(ContainerBuilder $container): void
|
|
{
|
|
$this->types = [];
|
|
$this->ambiguousServiceTypes = [];
|
|
$this->autowiringAliases = [];
|
|
|
|
foreach ($container->getDefinitions() as $id => $definition) {
|
|
$this->populateAvailableType($container, $id, $definition);
|
|
}
|
|
|
|
$prev = null;
|
|
foreach ($container->getAliases() as $id => $alias) {
|
|
$this->populateAutowiringAlias($id, $prev);
|
|
$prev = $id;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Populates the list of available types for a given definition.
|
|
*/
|
|
private function populateAvailableType(ContainerBuilder $container, string $id, Definition $definition): void
|
|
{
|
|
// 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());
|
|
|
|
$this->populateAutowiringAlias($id);
|
|
}
|
|
|
|
/**
|
|
* Associates a type and a service id if applicable.
|
|
*/
|
|
private function set(string $type, string $id): void
|
|
{
|
|
// 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): \Closure
|
|
{
|
|
if (!isset($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 (fn () => $this->createTypeNotFoundMessage($reference, $label, $currentId))->bindTo($this->typesClone);
|
|
}
|
|
|
|
private function createTypeNotFoundMessage(TypedReference $reference, string $label, string $currentId): string
|
|
{
|
|
$type = $reference->getType();
|
|
|
|
$i = null;
|
|
$namespace = $type;
|
|
do {
|
|
$namespace = substr($namespace, 0, $i);
|
|
|
|
if ($this->container->hasDefinition($namespace) && $tag = $this->container->getDefinition($namespace)->getTag('container.excluded')) {
|
|
return \sprintf('Cannot autowire service "%s": %s needs an instance of "%s" but this type has been excluded %s.', $currentId, $label, $type, $tag[0]['source'] ?? 'from autowiring');
|
|
}
|
|
} while (false !== $i = strrpos($namespace, '\\'));
|
|
|
|
if (!$r = $this->container->getReflectionClass($type, false)) {
|
|
// either $type does not exist or a parent class does not exist
|
|
try {
|
|
if (class_exists(ClassExistenceResource::class)) {
|
|
$resource = new ClassExistenceResource($type, false);
|
|
// isFresh() will explode ONLY if a parent class/trait does not exist
|
|
$resource->isFresh(0);
|
|
$parentMsg = false;
|
|
} else {
|
|
$parentMsg = "couldn't be loaded. Either it was not found or it is missing a parent class or a trait";
|
|
}
|
|
} catch (\ReflectionException $e) {
|
|
$parentMsg = \sprintf('is missing a parent class (%s)', $e->getMessage());
|
|
}
|
|
|
|
$message = \sprintf('has type "%s" but this class %s.', $type, $parentMsg ?: 'was not found');
|
|
} else {
|
|
$alternatives = $this->createTypeAlternatives($this->container, $reference);
|
|
|
|
if (null !== $target = (array_filter($reference->getAttributes(), static fn ($a) => $a instanceof Target)[0] ?? null)) {
|
|
$target = null !== $target->name ? "('{$target->name}')" : '';
|
|
$message = \sprintf('has "#[Target%s]" but no such target exists.%s', $target, $alternatives);
|
|
} else {
|
|
$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 an instantiable 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 (!isset($this->ambiguousServiceTypes)) {
|
|
$this->populateAvailableTypes($container);
|
|
}
|
|
|
|
$servicesAndAliases = $container->getServiceIds();
|
|
$autowiringAliases = $this->autowiringAliases[$type] ?? [];
|
|
unset($autowiringAliases['']);
|
|
|
|
if ($autowiringAliases) {
|
|
return \sprintf(' Did you mean to target%s "%s" instead?', 1 < \count($autowiringAliases) ? ' one of' : '', implode('", "', $autowiringAliases));
|
|
}
|
|
|
|
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]);
|
|
}
|
|
|
|
return $message.\sprintf('or %s "%s".', class_exists($aliases[$i], false) ? 'class' : 'interface', $aliases[$i]);
|
|
}
|
|
|
|
if ($aliases) {
|
|
return \sprintf('Try changing the type-hint to "%s" instead.', $aliases[0]);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private function populateAutowiringAlias(string $id, ?string $target = null): void
|
|
{
|
|
if (!preg_match('/(?(DEFINE)(?<V>[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+))^((?&V)(?:\\\\(?&V))*+)(?: \$((?&V)))?$/', $id, $m)) {
|
|
return;
|
|
}
|
|
|
|
$type = $m[2];
|
|
$name = $m[3] ?? '';
|
|
|
|
if (class_exists($type, false) || interface_exists($type, false)) {
|
|
if (null !== $target && str_starts_with($target, '.'.$type.' $')
|
|
&& (new Target($target = substr($target, \strlen($type) + 3)))->getParsedName() === $name
|
|
) {
|
|
$name = $target;
|
|
}
|
|
|
|
$this->autowiringAliases[$type][$name] = $name;
|
|
}
|
|
}
|
|
|
|
private function getCombinedAlias(string $type, ?string $name = null): ?string
|
|
{
|
|
if (str_contains($type, '&')) {
|
|
$types = explode('&', $type);
|
|
} elseif (str_contains($type, '|')) {
|
|
$types = explode('|', $type);
|
|
} else {
|
|
return null;
|
|
}
|
|
|
|
$alias = null;
|
|
$suffix = $name ? ' $'.$name : '';
|
|
|
|
foreach ($types as $type) {
|
|
if (!$this->container->hasAlias($type.$suffix)) {
|
|
return null;
|
|
}
|
|
|
|
if (null === $alias) {
|
|
$alias = (string) $this->container->getAlias($type.$suffix);
|
|
} elseif ((string) $this->container->getAlias($type.$suffix) !== $alias) {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
return $alias;
|
|
}
|
|
}
|