| 1 |
<?php |
| 2 |
|
| 3 |
declare(strict_types=1); |
| 4 |
|
| 5 |
namespace WPDeveloper\BetterDocs\Dependencies\DI\Definition\Resolver; |
| 6 |
|
| 7 |
use WPDeveloper\BetterDocs\Dependencies\DI\Definition\Definition; |
| 8 |
use WPDeveloper\BetterDocs\Dependencies\DI\Definition\Exception\InvalidDefinition; |
| 9 |
use WPDeveloper\BetterDocs\Dependencies\DI\Definition\FactoryDefinition; |
| 10 |
use WPDeveloper\BetterDocs\Dependencies\DI\Invoker\FactoryParameterResolver; |
| 11 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\Exception\NotCallableException; |
| 12 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\Exception\NotEnoughParametersException; |
| 13 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\Invoker; |
| 14 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\ParameterResolver\AssociativeArrayResolver; |
| 15 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\ParameterResolver\NumericArrayResolver; |
| 16 |
use WPDeveloper\BetterDocs\Dependencies\Invoker\ParameterResolver\ResolverChain; |
| 17 |
use WPDeveloper\BetterDocs\Dependencies\Psr\Container\ContainerInterface; |
| 18 |
|
| 19 |
/** |
| 20 |
* Resolves a factory definition to a value. |
| 21 |
* |
| 22 |
* @since 4.0 |
| 23 |
* @author Matthieu Napoli <matthieu@mnapoli.fr> |
| 24 |
*/ |
| 25 |
class FactoryResolver implements DefinitionResolver |
| 26 |
{ |
| 27 |
/** |
| 28 |
* @var ContainerInterface |
| 29 |
*/ |
| 30 |
private $container; |
| 31 |
|
| 32 |
/** |
| 33 |
* @var WPDeveloper\BetterDocs\Dependencies\Invoker|null |
| 34 |
*/ |
| 35 |
private $invoker; |
| 36 |
|
| 37 |
/** |
| 38 |
* @var DefinitionResolver |
| 39 |
*/ |
| 40 |
private $resolver; |
| 41 |
|
| 42 |
/** |
| 43 |
* The resolver needs a container. This container will be passed to the factory as a parameter |
| 44 |
* so that the factory can access other entries of the container. |
| 45 |
*/ |
| 46 |
public function __construct(ContainerInterface $container, DefinitionResolver $resolver) |
| 47 |
{ |
| 48 |
$this->container = $container; |
| 49 |
$this->resolver = $resolver; |
| 50 |
} |
| 51 |
|
| 52 |
/** |
| 53 |
* Resolve a factory definition to a value. |
| 54 |
* |
| 55 |
* This will call the callable of the definition. |
| 56 |
* |
| 57 |
* @param FactoryDefinition $definition |
| 58 |
* |
| 59 |
* {@inheritdoc} |
| 60 |
*/ |
| 61 |
public function resolve(Definition $definition, array $parameters = []) |
| 62 |
{ |
| 63 |
if (! $this->invoker) { |
| 64 |
$parameterResolver = new ResolverChain([ |
| 65 |
new AssociativeArrayResolver, |
| 66 |
new FactoryParameterResolver($this->container), |
| 67 |
new NumericArrayResolver, |
| 68 |
]); |
| 69 |
|
| 70 |
$this->invoker = new Invoker($parameterResolver, $this->container); |
| 71 |
} |
| 72 |
|
| 73 |
$callable = $definition->getCallable(); |
| 74 |
|
| 75 |
try { |
| 76 |
$providedParams = [$this->container, $definition]; |
| 77 |
$extraParams = $this->resolveExtraParams($definition->getParameters()); |
| 78 |
$providedParams = array_merge($providedParams, $extraParams); |
| 79 |
|
| 80 |
return $this->invoker->call($callable, $providedParams); |
| 81 |
} catch (NotCallableException $e) { |
| 82 |
// Custom error message to help debugging |
| 83 |
if (is_string($callable) && class_exists($callable) && method_exists($callable, '__invoke')) { |
| 84 |
throw new InvalidDefinition(sprintf( |
| 85 |
'Entry "%s" cannot be resolved: factory %s. Invokable classes cannot be automatically resolved if autowiring is disabled on the container, you need to enable autowiring or define the entry manually.', |
| 86 |
$definition->getName(), |
| 87 |
$e->getMessage() |
| 88 |
)); |
| 89 |
} |
| 90 |
|
| 91 |
throw new InvalidDefinition(sprintf( |
| 92 |
'Entry "%s" cannot be resolved: factory %s', |
| 93 |
$definition->getName(), |
| 94 |
$e->getMessage() |
| 95 |
)); |
| 96 |
} catch (NotEnoughParametersException $e) { |
| 97 |
throw new InvalidDefinition(sprintf( |
| 98 |
'Entry "%s" cannot be resolved: %s', |
| 99 |
$definition->getName(), |
| 100 |
$e->getMessage() |
| 101 |
)); |
| 102 |
} |
| 103 |
} |
| 104 |
|
| 105 |
public function isResolvable(Definition $definition, array $parameters = []) : bool |
| 106 |
{ |
| 107 |
return true; |
| 108 |
} |
| 109 |
|
| 110 |
private function resolveExtraParams(array $params) : array |
| 111 |
{ |
| 112 |
$resolved = []; |
| 113 |
foreach ($params as $key => $value) { |
| 114 |
// Nested definitions |
| 115 |
if ($value instanceof Definition) { |
| 116 |
$value = $this->resolver->resolve($value); |
| 117 |
} |
| 118 |
$resolved[$key] = $value; |
| 119 |
} |
| 120 |
|
| 121 |
return $resolved; |
| 122 |
} |
| 123 |
} |
| 124 |
|