Injector::make() - Code Metrics - Inspection of "Added `make` method and tests" - yiisoft/injector - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by Alexander

created 2020-04-04 12:23 UTC

Injector::make() A

↳ Parent: Injector

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	3
nop	2
dl	0
loc	13
ccs	8
cts	8
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Injector;

use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Psr\Container\NotFoundExceptionInterface;
use ReflectionException;

/**
 * Injector is able to analyze callable dependencies based on
 * type hinting and inject them from any PSR-11 compatible container.
 */
final class Injector
{
    private ContainerInterface $container;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    /**
     * Invoke a callback with resolving dependencies based on parameter types.
     *
     * This methods allows invoking a callback and let type hinted parameter names to be
     * resolved as objects of the Container. It additionally allow calling function passing named arguments.
     *
     * For example, the following callback may be invoked using the Container to resolve the formatter dependency:
     *
     * ```php
     * $formatString = function($string, \Yiisoft\I18n\MessageFormatterInterface $formatter) {
     *    // ...
     * }
     *
     * $injector = new Yiisoft\Injector\Injector($container);
     * $injector->invoke($formatString, ['string' => 'Hello World!']);
     * ```
     *
     * This will pass the string `'Hello World!'` as the first argument, and a formatter instance created
     * by the DI container as the second argument.
     *
     * @param callable $callable callable to be invoked.
     * @param array $arguments The array of the function arguments.
     * This can be either a list of arguments, or an associative array where keys are argument names.
     * @return mixed the callable return value.
     * @throws MissingRequiredArgumentException if required argument is missing.
     * @throws ContainerExceptionInterface if a dependency cannot be resolved or if a dependency cannot be fulfilled.
     * @throws ReflectionException
     */
    public function invoke(callable $callable, array $arguments = [])
    {
        if (\is_object($callable) && !$callable instanceof \Closure) {
            $callable = [$callable, '__invoke'];
        }

        if (\is_array($callable)) {
            $reflection = new \ReflectionMethod($callable[0], $callable[1]);
        } else {
            $reflection = new \ReflectionFunction($callable);
        }

        return \call_user_func_array($callable, $this->resolveDependencies($reflection, $arguments));
    }

    /**
     * Creates an object of a given class with resolving constructor dependencies based on parameter types.
     *
     * This methods allows invoking a constructor and let type hinted parameter names to be
     * resolved as objects of the Container. It additionally allow calling constructor passing named arguments.
     *
     * For example, the following constructor may be invoked using the Container to resolve the formatter dependency:
     *
     * ```php
     * class StringFormatter
     * {
     *     public function __construct($string, \Yiisoft\I18n\MessageFormatterInterface $formatter)
     *     {
     *         // ...
     *     }
     * }
     * 
     * $injector = new Yiisoft\Injector\Injector($container);
     * $stringFormatter = $injector->make(StringFormatter::class, ['string' => 'Hello World!']);
     * ```
     *
     * This will pass the string `'Hello World!'` as the first argument, and a formatter instance created
     * by the DI container as the second argument.
     *
     * @param string $class name of the class to be created.
     * @param array $arguments The array of the function arguments.
     * This can be either a list of arguments, or an associative array where keys are argument names.
     * @return mixed object of the given class.
     * @throws ContainerExceptionInterface
     * @throws MissingRequiredArgumentException|InvalidArgumentException
     * @throws ReflectionException
     */
    public function make(string $class, array $arguments = [])
    {
        $classReflection = new \ReflectionClass($class);
        if (!$classReflection->isInstantiable()) {
            throw new \InvalidArgumentException("Class $class is not instantiable");
        }
        $reflection = $classReflection->getConstructor();
        if ($reflection === null) {
            // Method __construct() does not exist
            return new $class();
        }

        return new $class(...$this->resolveDependencies($reflection, $arguments));
    }

    /**
     * Resolve dependencies for the given function reflection object and a list of concrete arguments
     * and return array of arguments to call the function with.
     *
     * @param \ReflectionFunctionAbstract $reflection function reflection.
     * @param array $arguments concrete arguments.
     * @return array resolved arguments.
     * @throws ContainerExceptionInterface
     * @throws MissingRequiredArgumentException|InvalidArgumentException
     * @throws ReflectionException
     */
    private function resolveDependencies(\ReflectionFunctionAbstract $reflection, array $arguments = []): array
    {
        $resolvedArguments = [];

        $pushUnusedArguments = true;
        foreach ($reflection->getParameters() as $parameter) {
            $name = $parameter->getName();
            $class = $parameter->getClass();
            $hasType = $parameter->hasType();
            $isNullable = $parameter->allowsNull() && $hasType;
            $isVariadic = $parameter->isVariadic();
            $error = null;

            // Get argument by name
            if (array_key_exists($name, $arguments)) {
                if ($isVariadic && is_array($arguments[$name])) {
                    $resolvedArguments = array_merge($resolvedArguments, array_values($arguments[$name]));
                } else {
                    $resolvedArguments[] = $arguments[$name];
                }
                unset($arguments[$name]);
                continue;
            }

            if ($class !== null) {
                // Unnamed arguments
                $className = $class->getName();
                $found = false;
                foreach ($arguments as $key => $item) {
                    if (!is_int($key)) {
                        continue;
                    }
                    if ($item instanceof $className) {
                        $found = true;
                        $resolvedArguments[] = $item;
                        unset($arguments[$key]);
                        if (!$isVariadic) {
                            break;
                        }
                    }
                }
                if ($found) {
                    $pushUnusedArguments = false;
                    continue;
                }

                // If the argument is optional we catch not instantiable exceptions
                try {
                    $resolvedArguments[] = $this->container->get($className);
                    continue;
                } catch (NotFoundExceptionInterface $e) {
                    $error = $e;
                }
            }

            if ($parameter->isDefaultValueAvailable()) {
                $resolvedArguments[] = $parameter->getDefaultValue();
            } elseif (!$parameter->isOptional()) {
                if ($isNullable) {
                    $resolvedArguments[] = null;
                } else {
                    throw $error ?? new MissingRequiredArgumentException($name, $reflection->getName());
                }
            } elseif ($hasType) {
                $pushUnusedArguments = false;
            }
        }

        foreach ($arguments as $key => $value) {
            if (is_int($key)) {
                if (!is_object($value)) {
                    throw new InvalidArgumentException((string)$key, $reflection->getName());
                }
                if ($pushUnusedArguments) {
                    $resolvedArguments[] = $value;
                }
            }
        }
        return $resolvedArguments;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Injector;
6
7		use Psr\Container\ContainerExceptionInterface;
8		use Psr\Container\ContainerInterface;
9		use Psr\Container\NotFoundExceptionInterface;
10		use ReflectionException;
11
12		/**
13		* Injector is able to analyze callable dependencies based on
14		* type hinting and inject them from any PSR-11 compatible container.
15		*/
16		final class Injector
17		{
18		private ContainerInterface $container;
19
20	39	public function __construct(ContainerInterface $container)
21		{
22	39	$this->container = $container;
23		}
24
25		/**
26		* Invoke a callback with resolving dependencies based on parameter types.
27		*
28		* This methods allows invoking a callback and let type hinted parameter names to be
29		* resolved as objects of the Container. It additionally allow calling function passing named arguments.
30		*
31		* For example, the following callback may be invoked using the Container to resolve the formatter dependency:
32		*
33		* ```php
34		* $formatString = function($string, \Yiisoft\I18n\MessageFormatterInterface $formatter) {
35		* // ...
36		* }
37		*
38		* $injector = new Yiisoft\Injector\Injector($container);
39		* $injector->invoke($formatString, ['string' => 'Hello World!']);
40		* ```
41		*
42		* This will pass the string `'Hello World!'` as the first argument, and a formatter instance created
43		* by the DI container as the second argument.
44		*
45		* @param callable $callable callable to be invoked.
46		* @param array $arguments The array of the function arguments.
47		* This can be either a list of arguments, or an associative array where keys are argument names.
48		* @return mixed the callable return value.
49		* @throws MissingRequiredArgumentException if required argument is missing.
50		* @throws ContainerExceptionInterface if a dependency cannot be resolved or if a dependency cannot be fulfilled.
51		* @throws ReflectionException
52		*/
53	28	public function invoke(callable $callable, array $arguments = [])
54		{
55	28	if (\is_object($callable) && !$callable instanceof \Closure) {
56		$callable = [$callable, '__invoke'];
57		}
58
59	28	if (\is_array($callable)) {
60	3	$reflection = new \ReflectionMethod($callable[0], $callable[1]);
61		} else {
62	25	$reflection = new \ReflectionFunction($callable);
63		}
64
65	28	return \call_user_func_array($callable, $this->resolveDependencies($reflection, $arguments));
66		}
67
68		/**
69		* Creates an object of a given class with resolving constructor dependencies based on parameter types.
70		*
71		* This methods allows invoking a constructor and let type hinted parameter names to be
72		* resolved as objects of the Container. It additionally allow calling constructor passing named arguments.
73		*
74		* For example, the following constructor may be invoked using the Container to resolve the formatter dependency:
75		*
76		* ```php
77		* class StringFormatter
78		* {
79		* public function __construct($string, \Yiisoft\I18n\MessageFormatterInterface $formatter)
80		* {
81		* // ...
82		* }
83		* }
84		*
85		* $injector = new Yiisoft\Injector\Injector($container);
86		* $stringFormatter = $injector->make(StringFormatter::class, ['string' => 'Hello World!']);
87		* ```
88		*
89		* This will pass the string `'Hello World!'` as the first argument, and a formatter instance created
90		* by the DI container as the second argument.
91		*
92		* @param string $class name of the class to be created.
93		* @param array $arguments The array of the function arguments.
94		* This can be either a list of arguments, or an associative array where keys are argument names.
95		* @return mixed object of the given class.
96		* @throws ContainerExceptionInterface
97		* @throws MissingRequiredArgumentException\|InvalidArgumentException
98		* @throws ReflectionException
99		*/
100	11	public function make(string $class, array $arguments = [])
101		{
102	11	$classReflection = new \ReflectionClass($class);
103	10	if (!$classReflection->isInstantiable()) {
104	3	throw new \InvalidArgumentException("Class $class is not instantiable");
105		}
106	7	$reflection = $classReflection->getConstructor();
107	7	if ($reflection === null) {
108		// Method __construct() does not exist
109	1	return new $class();
110		}
111
112	6	return new $class(...$this->resolveDependencies($reflection, $arguments));
113		}
114
115		/**
116		* Resolve dependencies for the given function reflection object and a list of concrete arguments
117		* and return array of arguments to call the function with.
118		*
119		* @param \ReflectionFunctionAbstract $reflection function reflection.
120		* @param array $arguments concrete arguments.
121		* @return array resolved arguments.
122		* @throws ContainerExceptionInterface
123		* @throws MissingRequiredArgumentException\|InvalidArgumentException
124		* @throws ReflectionException
125		*/
126	34	private function resolveDependencies(\ReflectionFunctionAbstract $reflection, array $arguments = []): array
127		{
128	34	$resolvedArguments = [];
129
130	34	$pushUnusedArguments = true;
131	34	foreach ($reflection->getParameters() as $parameter) {
132	30	$name = $parameter->getName();
133	30	$class = $parameter->getClass();
134	30	$hasType = $parameter->hasType();
135	30	$isNullable = $parameter->allowsNull() && $hasType;
136	30	$isVariadic = $parameter->isVariadic();
137	30	$error = null;
138
139		// Get argument by name
140	30	if (array_key_exists($name, $arguments)) {
141	6	if ($isVariadic && is_array($arguments[$name])) {
142	1	$resolvedArguments = array_merge($resolvedArguments, array_values($arguments[$name]));
143		} else {
144	5	$resolvedArguments[] = $arguments[$name];
145		}
146	6	unset($arguments[$name]);
147	6	continue;
148		}
149
150	27	if ($class !== null) {
151		// Unnamed arguments
152	19	$className = $class->getName();
153	19	$found = false;
154	19	foreach ($arguments as $key => $item) {
155	8	if (!is_int($key)) {
156	1	continue;
157		}
158	7	if ($item instanceof $className) {
159	6	$found = true;
160	6	$resolvedArguments[] = $item;
161	6	unset($arguments[$key]);
162	6	if (!$isVariadic) {
163	4	break;
164		}
165		}
166		}
167	19	if ($found) {
168	6	$pushUnusedArguments = false;
169	6	continue;
170		}
171
172		// If the argument is optional we catch not instantiable exceptions
173		try {
174	17	$resolvedArguments[] = $this->container->get($className);
175	15	continue;
176	3	} catch (NotFoundExceptionInterface $e) {
177	3	$error = $e;
178		}
179		}
180
181	14	if ($parameter->isDefaultValueAvailable()) {
182	2	$resolvedArguments[] = $parameter->getDefaultValue();
183	12	} elseif (!$parameter->isOptional()) {
184	8	if ($isNullable) {
185	2	$resolvedArguments[] = null;
186		} else {
187	8	throw $error ?? new MissingRequiredArgumentException($name, $reflection->getName());
188		}
189	4	} elseif ($hasType) {
190	2	$pushUnusedArguments = false;
191		}
192		}
193
194	28	foreach ($arguments as $key => $value) {
195	7	if (is_int($key)) {
196	7	if (!is_object($value)) {
197	2	throw new InvalidArgumentException((string)$key, $reflection->getName());
198		}
199	5	if ($pushUnusedArguments) {
200	2	$resolvedArguments[] = $value;
201		}
202		}
203		}
204	26	return $resolvedArguments;
205		}
206		}
207

yiisoft / injector

Pull Request — master (#4)

Injector::make() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like