<?php
declare(strict_types=1);
namespace DI;
use DI\Compiler\RequestedEntryHolder;
use DI\Definition\Definition;
use DI\Definition\Exception\InvalidDefinition;
use DI\Invoker\FactoryParameterResolver;
use Invoker\Exception\NotCallableException;
use Invoker\Exception\NotEnoughParametersException;
use Invoker\Invoker;
use Invoker\InvokerInterface;
use Invoker\ParameterResolver\AssociativeArrayResolver;
use Invoker\ParameterResolver\DefaultValueResolver;
use Invoker\ParameterResolver\NumericArrayResolver;
use Invoker\ParameterResolver\ResolverChain;
/**
* Compiled version of the dependency injection container.
*
* @author Matthieu Napoli <[email protected]>
*/
abstract class CompiledContainer extends Container
{
/**
* This const is overridden in child classes (compiled containers).
* @var array
*/
protected const METHOD_MAPPING = [];
/**
* @var InvokerInterface
*/
private $factoryInvoker;
/**
* {@inheritdoc}
*/
public function get($name)
{
// Try to find the entry in the singleton map
if (isset($this->resolvedEntries[$name]) || array_key_exists($name, $this->resolvedEntries)) {
return $this->resolvedEntries[$name];
}
$method = static::METHOD_MAPPING[$name] ?? null;
// If it's a compiled entry, then there is a method in this class
if ($method !== null) {
// Check if we are already getting this entry -> circular dependency
if (isset($this->entriesBeingResolved[$name])) {
throw new DependencyException("Circular dependency detected while trying to resolve entry '$name'");
}
$this->entriesBeingResolved[$name] = true;
try {
$value = $this->$method();
} finally {
unset($this->entriesBeingResolved[$name]);
}
// Store the entry to always return it without recomputing it
$this->resolvedEntries[$name] = $value;
return $value;
}
return parent::get($name);
}
/**
* {@inheritdoc}
*/
public function has($name)
{
if (! is_string($name)) {
throw new \InvalidArgumentException(sprintf(
'The name parameter must be of type string, %s given',
is_object($name) ? get_class($name) : gettype($name)
));
}
// The parent method is overridden to check in our array, it avoids resolving definitions
if (isset(static::METHOD_MAPPING[$name])) {
return true;
}
return parent::has($name);
}
protected function setDefinition(string $name, Definition $definition)
{
// It needs to be forbidden because that would mean get() must go through the definitions
// every time, which kinds of defeats the performance gains of the compiled container
throw new \LogicException('You cannot set a definition at runtime on a compiled container. You can either put your definitions in a file, disable compilation or ->set() a raw value directly (PHP object, string, int, ...) instead of a PHP-DI definition.');
}
/**
* Invoke the given callable.
*/
protected function resolveFactory($callable, $entryName, array $extraParameters = [])
{
// Initialize the factory resolver
if (! $this->factoryInvoker) {
$parameterResolver = new ResolverChain([
new AssociativeArrayResolver,
new FactoryParameterResolver($this->delegateContainer),
new NumericArrayResolver,
new DefaultValueResolver,
]);
$this->factoryInvoker = new Invoker($parameterResolver, $this->delegateContainer);
}
$parameters = [$this->delegateContainer, new RequestedEntryHolder($entryName)];
$parameters = array_merge($parameters, $extraParameters);
try {
return $this->factoryInvoker->call($callable, $parameters);
} catch (NotCallableException $e) {
throw new InvalidDefinition("Entry \"$entryName\" cannot be resolved: factory " . $e->getMessage());
} catch (NotEnoughParametersException $e) {
throw new InvalidDefinition("Entry \"$entryName\" cannot be resolved: " . $e->getMessage());
}
}
}