Container::initialize() - Code Metrics - Inspection of "2.0.0" - mindplay-dk/unbox - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Rasmus

created 2016-09-29 12:19 UTC

Container::initialize() A

↳ Parent: Container

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	13
cts	13
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	9
nc	4
nop	1
crap	4

<?php

namespace mindplay\unbox;

use Interop\Container\ContainerInterface;
use InvalidArgumentException;
use ReflectionClass;
use ReflectionFunction;
use ReflectionParameter;

/**
 * This class implements a simple dependency injection container.
 */
class Container extends Configuration implements ContainerInterface, FactoryInterface
{
    /**
     * @var bool[] map where component name => TRUE, if the component has been initialized
     */
    protected $active = [];

    /**
     * @param Configuration $config
     */
    public function __construct(Configuration $config)
    {
        $config->copyTo($this);

        $this->values = $this->values +

            [
                get_class($this)          => $this,
                __CLASS__                 => $this,
                ContainerInterface::class => $this,
                FactoryInterface::class   => $this,
            ];
    }

    /**
     * Resolve the registered component with the given name.
     *
     * @param string $name component name
     *
     * @return mixed
     *
     * @throws ContainerException
     * @throws NotFoundException
     */
    public function get($name)
    {
        if (! isset($this->active[$name])) {
            if (isset($this->factory[$name])) {
                $factory = $this->factory[$name];

                $reflection = new ReflectionFunction($factory);

                $params = $this->resolve($reflection->getParameters(), $this->factory_map[$name]);

                $this->values[$name] = call_user_func_array($factory, $params);
            } elseif (!array_key_exists($name, $this->values)) {
                throw new NotFoundException($name);
            }

            $this->active[$name] = true;

            $this->initialize($name);
        }

        return $this->values[$name];
    }

    /**
     * Check for the existence of a component with a given name.
     *
     * @param string $name component name
     *
     * @return bool true, if a component with the given name has been defined
     */
    public function has($name)
    {
        return array_key_exists($name, $this->values) || isset($this->factory[$name]);
    }

    /**
     * Check if a component has been unboxed and is currently active.
     *
     * @param string $name component name
     *
     * @return bool
     */
    public function isActive($name)
    {
        return isset($this->active[$name]);
    }

    /**
     * Call any given callable, using dependency injection to satisfy it's arguments, and/or
     * manually specifying some of those arguments - then return the value from the call.
     *
     * This will work for any callable:
     *
     *     $container->call('foo');               // function foo()
     *     $container->call($foo, 'baz');         // instance method $foo->baz()
     *     $container->call([Foo::class, 'bar']); // static method Foo::bar()
     *     $container->call($foo);                // closure (or class implementing __invoke)
     *
     * In any of those examples, you can also supply custom arguments, either named or
     * positional, or mixed, as per the `$map` argument in `register()`, `configure()`, etc.
     *
     * See also {@see create()} which lets you invoke any constructor.
     *
     * @param callable|object $callback any arbitrary closure or callable, or object implementing __invoke()
     * @param mixed|mixed[]   $map      mixed list/map of parameter values (and/or boxed values)
     *
     * @return mixed return value from the given callable
     */
    public function call($callback, $map = [])
    {
        $params = Reflection::createFromCallable($callback)->getParameters();

        return call_user_func_array($callback, $this->resolve($params, $map));
    }

    /**
     * Create an instance of a given class.
     *
     * The container will internally resolve and inject any constructor arguments
     * not explicitly provided in the (optional) second parameter.
     *
     * @param string        $class_name fully-qualified class-name
     * @param mixed|mixed[] $map        mixed list/map of parameter values (and/or boxed values)
     *
     * @return mixed
     */
    public function create($class_name, $map = [])
    {
        if (!class_exists($class_name)) {
            throw new InvalidArgumentException("unable to create component: {$class_name}");
        }

        $reflection = new ReflectionClass($class_name);

        if (!$reflection->isInstantiable()) {
            throw new InvalidArgumentException("unable to create instance of abstract class: {$class_name}");
        }

        $constructor = $reflection->getConstructor();

        $params = $constructor
            ? $this->resolve($constructor->getParameters(), $map, false)
            : [];

        return $reflection->newInstanceArgs($params);
    }

    /**
     * Internally resolves parameters to functions or constructors.
     *
     * This is the heart of the beast.
     *
     * @param ReflectionParameter[] $params parameter reflections
     * @param array                 $map    mixed list/map of parameter values (and/or boxed values)
     * @param bool                  $safe   if TRUE, it's considered safe to resolve against parameter names
     *
     * @return array parameters
     *
     * @throws ContainerException
     * @throws NotFoundException
     */
    protected function resolve(array $params, $map, $safe = true)
    {
        $args = [];

        foreach ($params as $index => $param) {
            $param_name = $param->name;

            if (array_key_exists($param_name, $map)) {
                $value = $map[$param_name]; // // resolve as user-provided named argument
            } elseif (array_key_exists($index, $map)) {
                $value = $map[$index]; // resolve as user-provided positional argument
            } else {
                // as on optimization, obtain the argument type without triggering autoload:

                $type = Reflection::getParameterType($param);

                if ($type && isset($map[$type])) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $value = $map[$type]; // resolve as user-provided type-hinted argument
                } elseif ($type && $this->has($type)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $value = $this->get($type); // resolve as component registered by class/interface name
                } elseif ($safe && $this->has($param_name)) {
                    $value = $this->get($param_name); // resolve as component with matching parameter name
                } elseif ($param->isOptional()) {
                    $value = $param->getDefaultValue(); // unresolved, optional: resolve using default value
                } elseif ($type && $param->allowsNull()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $value = null; // unresolved, type-hinted, nullable: resolve as NULL
                } else {
                    // unresolved - throw a container exception:

                    $reflection = $param->getDeclaringFunction();

                    throw new ContainerException(
                        "unable to resolve parameter: \${$param_name} " . ($type ? "({$type}) " : "") .
                        "in file: " . $reflection->getFileName() . ", line " . $reflection->getStartLine()
                    );
                }
            }

            if ($value instanceof BoxedValueInterface) {
                $value = $value->unbox($this); // unbox a boxed value
            }

            $args[] = $value; // argument resolved!
        }

        return $args;
    }

    /**
     * Dynamically inject a component into this Container.
     *
     * Enables classes that extend `Container` to dynamically inject components (to implement "auto-wiring")
     *
     * @param string $name
     * @param mixed  $value
     */
    protected function inject($name, $value)
    {
        $this->values[$name] = $value;
        $this->active[$name] = true;
    }

    /**
     * Internally initialize an active component.
     *
     * @param string $name component name
     *
     * @return void
     */
    private function initialize($name)
    {
        if (isset($this->config[$name])) {
            foreach ($this->config[$name] as $index => $config) {
                $map = $this->config_map[$name][$index];

                $reflection = Reflection::createFromCallable($config);

                $params = $this->resolve($reflection->getParameters(), $map);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                $value = call_user_func_array($config, $params);

                if ($value !== null) {
                    $this->values[$name] = $value;
                }
            }
        }
    }
}


1		<?php
2
3		namespace mindplay\unbox;
4
5		use Interop\Container\ContainerInterface;
6		use InvalidArgumentException;
7		use ReflectionClass;
8		use ReflectionFunction;
9		use ReflectionParameter;
10
11		/**
12		* This class implements a simple dependency injection container.
13		*/
14		class Container extends Configuration implements ContainerInterface, FactoryInterface
15		{
16		/**
17		* @var bool[] map where component name => TRUE, if the component has been initialized
18		*/
19		protected $active = [];
20
21		/**
22		* @param Configuration $config
23		*/
24	1	public function __construct(Configuration $config)
25		{
26	1	$config->copyTo($this);
27
28	1	$this->values = $this->values +
		0 ignored issues – show Documentation Bug introduced 2016-09-29 12:21 UTC by Report Bug Copy Issue Report It seems like `$this->values + array(ge...erface::class => $this)` of type `array<integer\|string,>` is incompatible with the declared type `array<integer,>` of property `$values`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
29		[
30	1	get_class($this) => $this,
31	1	__CLASS__ => $this,
32	1	ContainerInterface::class => $this,
33	1	FactoryInterface::class => $this,
34	1	];
35	1	}
36
37		/**
38		* Resolve the registered component with the given name.
39		*
40		* @param string $name component name
41		*
42		* @return mixed
43		*
44		* @throws ContainerException
45		* @throws NotFoundException
46		*/
47	1	public function get($name)
48		{
49	1	if (! isset($this->active[$name])) {
50	1	if (isset($this->factory[$name])) {
51	1	$factory = $this->factory[$name];
52
53	1	$reflection = new ReflectionFunction($factory);
54
55	1	$params = $this->resolve($reflection->getParameters(), $this->factory_map[$name]);
56
57	1	$this->values[$name] = call_user_func_array($factory, $params);
58	1	} elseif (!array_key_exists($name, $this->values)) {
59	1	throw new NotFoundException($name);
60		}
61
62	1	$this->active[$name] = true;
63
64	1	$this->initialize($name);
65	1	}
66
67	1	return $this->values[$name];
68		}
69
70		/**
71		* Check for the existence of a component with a given name.
72		*
73		* @param string $name component name
74		*
75		* @return bool true, if a component with the given name has been defined
76		*/
77	1	public function has($name)
78		{
79	1	return array_key_exists($name, $this->values) \|\| isset($this->factory[$name]);
80		}
81
82		/**
83		* Check if a component has been unboxed and is currently active.
84		*
85		* @param string $name component name
86		*
87		* @return bool
88		*/
89	1	public function isActive($name)
90		{
91	1	return isset($this->active[$name]);
92		}
93
94		/**
95		* Call any given callable, using dependency injection to satisfy it's arguments, and/or
96		* manually specifying some of those arguments - then return the value from the call.
97		*
98		* This will work for any callable:
99		*
100		* $container->call('foo'); // function foo()
101		* $container->call($foo, 'baz'); // instance method $foo->baz()
102		* $container->call([Foo::class, 'bar']); // static method Foo::bar()
103		* $container->call($foo); // closure (or class implementing __invoke)
104		*
105		* In any of those examples, you can also supply custom arguments, either named or
106		* positional, or mixed, as per the `$map` argument in `register()`, `configure()`, etc.
107		*
108		* See also {@see create()} which lets you invoke any constructor.
109		*
110		* @param callable\|object $callback any arbitrary closure or callable, or object implementing __invoke()
111		* @param mixed\|mixed[] $map mixed list/map of parameter values (and/or boxed values)
112		*
113		* @return mixed return value from the given callable
114		*/
115	1	public function call($callback, $map = [])
116		{
117	1	$params = Reflection::createFromCallable($callback)->getParameters();
118
119	1	return call_user_func_array($callback, $this->resolve($params, $map));
120		}
121
122		/**
123		* Create an instance of a given class.
124		*
125		* The container will internally resolve and inject any constructor arguments
126		* not explicitly provided in the (optional) second parameter.
127		*
128		* @param string $class_name fully-qualified class-name
129		* @param mixed\|mixed[] $map mixed list/map of parameter values (and/or boxed values)
130		*
131		* @return mixed
132		*/
133	1	public function create($class_name, $map = [])
134		{
135	1	if (!class_exists($class_name)) {
136	1	throw new InvalidArgumentException("unable to create component: {$class_name}");
137		}
138
139	1	$reflection = new ReflectionClass($class_name);
140
141	1	if (!$reflection->isInstantiable()) {
142	1	throw new InvalidArgumentException("unable to create instance of abstract class: {$class_name}");
143		}
144
145	1	$constructor = $reflection->getConstructor();
146
147		$params = $constructor
148	1	? $this->resolve($constructor->getParameters(), $map, false)
149	1	: [];
150
151	1	return $reflection->newInstanceArgs($params);
152		}
153
154		/**
155		* Internally resolves parameters to functions or constructors.
156		*
157		* This is the heart of the beast.
158		*
159		* @param ReflectionParameter[] $params parameter reflections
160		* @param array $map mixed list/map of parameter values (and/or boxed values)
161		* @param bool $safe if TRUE, it's considered safe to resolve against parameter names
162		*
163		* @return array parameters
164		*
165		* @throws ContainerException
166		* @throws NotFoundException
167		*/
168	1	protected function resolve(array $params, $map, $safe = true)
169		{
170	1	$args = [];
171
172	1	foreach ($params as $index => $param) {
173	1	$param_name = $param->name;
174
175	1	if (array_key_exists($param_name, $map)) {
176	1	$value = $map[$param_name]; // // resolve as user-provided named argument
177	1	} elseif (array_key_exists($index, $map)) {
178	1	$value = $map[$index]; // resolve as user-provided positional argument
179	1	} else {
180		// as on optimization, obtain the argument type without triggering autoload:
181
182	1	$type = Reflection::getParameterType($param);
183
184	1	if ($type && isset($map[$type])) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-21 20:03 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
185	1	$value = $map[$type]; // resolve as user-provided type-hinted argument
186	1	} elseif ($type && $this->has($type)) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-21 20:03 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
187	1	$value = $this->get($type); // resolve as component registered by class/interface name
188	1	} elseif ($safe && $this->has($param_name)) {
189	1	$value = $this->get($param_name); // resolve as component with matching parameter name
190	1	} elseif ($param->isOptional()) {
191	1	$value = $param->getDefaultValue(); // unresolved, optional: resolve using default value
192	1	} elseif ($type && $param->allowsNull()) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-29 12:21 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
193		$value = null; // unresolved, type-hinted, nullable: resolve as NULL
194		} else {
195		// unresolved - throw a container exception:
196
197	1	$reflection = $param->getDeclaringFunction();
198
199	1	throw new ContainerException(
200	1	"unable to resolve parameter: \${$param_name} " . ($type ? "({$type}) " : "") .
201	1	"in file: " . $reflection->getFileName() . ", line " . $reflection->getStartLine()
202	1	);
203		}
204		}
205
206	1	if ($value instanceof BoxedValueInterface) {
207	1	$value = $value->unbox($this); // unbox a boxed value
208	1	}
209
210	1	$args[] = $value; // argument resolved!
211	1	}
212
213	1	return $args;
214		}
215
216		/**
217		* Dynamically inject a component into this Container.
218		*
219		* Enables classes that extend `Container` to dynamically inject components (to implement "auto-wiring")
220		*
221		* @param string $name
222		* @param mixed $value
223		*/
224	1	protected function inject($name, $value)
225		{
226	1	$this->values[$name] = $value;
227	1	$this->active[$name] = true;
228	1	}
229
230		/**
231		* Internally initialize an active component.
232		*
233		* @param string $name component name
234		*
235		* @return void
236		*/
237	1	private function initialize($name)
238		{
239	1	if (isset($this->config[$name])) {
240	1	foreach ($this->config[$name] as $index => $config) {
241	1	$map = $this->config_map[$name][$index];
242
243	1	$reflection = Reflection::createFromCallable($config);
244
245	1	$params = $this->resolve($reflection->getParameters(), $map);
		0 ignored issues – show Documentation introduced 2016-09-29 12:21 UTC by Report Bug Copy Issue Report `$map` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
246
247	1	$value = call_user_func_array($config, $params);
248
249	1	if ($value !== null) {
250	1	$this->values[$name] = $value;
251	1	}
252	1	}
253	1	}
254	1	}
255		}
256

mindplay-dk / unbox

Pull Request — master (#7)

Container::initialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like