Factory::createDefinition() - Code Metrics - Inspection of "Refactor factory" - yiisoft/factory - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#146)

by Dmitriy

created 2021-09-23 06:40 UTC

Factory::createDefinition() A

↳ Parent: Factory

Complexity

Conditions	4
Paths	2

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	9
nc	2
nop	1
dl	0
loc	16
ccs	8
cts	8
cp	1
crap	4
rs	9.9666
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Factory;

use Psr\Container\ContainerInterface;
use Yiisoft\Definitions\ArrayDefinition;
use Yiisoft\Definitions\Contract\DefinitionInterface;
use Yiisoft\Definitions\Contract\ReferenceInterface;
use Yiisoft\Definitions\Infrastructure\DefinitionValidator;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Definitions\Exception\NotFoundException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Definitions\Infrastructure\Normalizer;

use function is_string;

/**
 * Factory allows creating objects passing arguments runtime.
 * A factory will try to use a PSR-11 compliant container to get dependencies,
 * but will fall back to manual instantiation
 * if the container cannot provide a required dependency.
 */
final class Factory
{
    private ?ContainerInterface $container;
    private FactoryContainer $factoryContainer;

    /**
     * @var bool $validate Validate definitions when set
     */
    private bool $validate;

    /**
     * Factory constructor.
     *
     * @psalm-param array<string, mixed> $definitions
     *
     * @throws InvalidConfigException
     */
    public function __construct(
        ContainerInterface $container = null,
        array $definitions = [],
        bool $validate = true
    ) {
        $this->container = $container;
        $this->factoryContainer = new FactoryContainer($container);
        $this->validate = $validate;
        $this->setMultiple($definitions);
    }

    /**
     * Creates a new object using the given configuration.
     *
     * You may view this method as an enhanced version of the `new` operator.
     * The method supports creating an object based on a class name, a configuration array or
     * an anonymous function.
     *
     * Below are some usage examples:
     *
     * ```php
     * // create an object using a class name
     * $object = $factory->create(\Yiisoft\Db\Connection::class);
     *
     * // create an object using a configuration array
     * $object = $factory->create([
     *     'class' => \Yiisoft\Db\Connection\Connection::class,
     *     '__construct()' => [
     *         'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
     *     ],
     *     'setUsername()' => ['root'],
     *     'setPassword()' => [''],
     *     'setCharset()' => ['utf8'],
     * ]);
     * ```
     *
     * Using [[Container|dependency injection container]], this method can also identify
     * dependent objects, instantiate them and inject them into the newly created object.
     *
     * @param mixed $config The object configuration. This can be specified in one of the following forms:
     *
     * - A string: representing the class name of the object to be created.
     *
     * - A configuration array: the array must contain a `class` element which is treated as the object class,
     *   and the rest of the name-value pairs will be used to initialize the corresponding object properties.
     *
     * - A PHP callable: either an anonymous function or an array representing a class method
     *   (`[$class or $object, $method]`). The callable should return a new instance of the object being created.
     *
     * @throws InvalidConfigException If the configuration is invalid.
     * @throws CircularReferenceException
     * @throws NotFoundException
     * @throws NotInstantiableException
     *
     * @return mixed|object The created object.
     *
     * @psalm-template T
     * @psalm-param mixed|class-string<T> $config
     * @psalm-return ($config is class-string ? T : mixed)
     * @psalm-suppress MixedReturnStatement
     */
    public function create($config)
    {
        if ($this->validate) {
            DefinitionValidator::validate($config);
        }

        if (is_string($config)) {
            if ($this->factoryContainer->hasDefinition($config)) {
                return $this->factoryContainer->get($config);
            }
            throw new NotFoundException($config);
        }

        $definition = $this->createDefinition($config);

        if ($definition instanceof ArrayDefinition) {
            $definition->setReferenceContainer($this->factoryContainer);
        }
        try {
            $container = ($this->container === null || $definition instanceof ReferenceInterface) ? $this->factoryContainer : $this->container;
            return $definition->resolve($container);
        } finally {
            if ($definition instanceof ArrayDefinition) {
                $definition->setReferenceContainer(null);
            }
        }
    }

    /**
     * Sets a definition to the factory.
     *
     * @param mixed $definition
     *
     * @throws InvalidConfigException
     */
    public function set(string $id, $definition): void
    {
        if ($this->validate) {
            DefinitionValidator::validate($definition, $id);
        }

        $this->factoryContainer->setDefinition($id, $definition);
    }

    /**
     * Sets multiple definitions at once.
     *
     * @param array $definitions definitions indexed by their ids
     *
     * @psalm-param array<string, mixed> $definitions
     *
     * @throws InvalidConfigException
     */
    public function setMultiple(array $definitions): void
    {
        /** @var mixed $definition */
        foreach ($definitions as $id => $definition) {
            $this->set($id, $definition);
        }
    }

    /**
     * @param mixed $config
     *
     * @throws InvalidConfigException
     */
    private function createDefinition($config): DefinitionInterface
    {
        $definition = Normalizer::normalize($config);

        if (
            ($definition instanceof ArrayDefinition) &&
            $this->factoryContainer->hasDefinition($definition->getClass()) &&
            ($containerDefinition = $this->factoryContainer->getDefinition($definition->getClass())) instanceof ArrayDefinition
        ) {
            $definition = $this->mergeDefinitions(
                $containerDefinition,
                $definition
            );
        }

        return $definition;
    }

    private function mergeDefinitions(DefinitionInterface $one, ArrayDefinition $two): DefinitionInterface
    {
        return $one instanceof ArrayDefinition ? $one->merge($two) : $two;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Factory;
6
7		use Psr\Container\ContainerInterface;
8		use Yiisoft\Definitions\ArrayDefinition;
9		use Yiisoft\Definitions\Contract\DefinitionInterface;
10		use Yiisoft\Definitions\Contract\ReferenceInterface;
11		use Yiisoft\Definitions\Infrastructure\DefinitionValidator;
12		use Yiisoft\Definitions\Exception\CircularReferenceException;
13		use Yiisoft\Definitions\Exception\InvalidConfigException;
14		use Yiisoft\Definitions\Exception\NotFoundException;
15		use Yiisoft\Definitions\Exception\NotInstantiableException;
16		use Yiisoft\Definitions\Infrastructure\Normalizer;
17
18		use function is_string;
19
20		/**
21		* Factory allows creating objects passing arguments runtime.
22		* A factory will try to use a PSR-11 compliant container to get dependencies,
23		* but will fall back to manual instantiation
24		* if the container cannot provide a required dependency.
25		*/
26		final class Factory
27		{
28		private ?ContainerInterface $container;
29		private FactoryContainer $factoryContainer;
30
31		/**
32		* @var bool $validate Validate definitions when set
33		*/
34		private bool $validate;
35
36		/**
37		* Factory constructor.
38		*
39		* @psalm-param array<string, mixed> $definitions
40		*
41		* @throws InvalidConfigException
42		*/
43	88	public function __construct(
44		ContainerInterface $container = null,
45		array $definitions = [],
46		bool $validate = true
47		) {
48	88	$this->container = $container;
49	88	$this->factoryContainer = new FactoryContainer($container);
50	88	$this->validate = $validate;
51	88	$this->setMultiple($definitions);
52	86	}
53
54		/**
55		* Creates a new object using the given configuration.
56		*
57		* You may view this method as an enhanced version of the `new` operator.
58		* The method supports creating an object based on a class name, a configuration array or
59		* an anonymous function.
60		*
61		* Below are some usage examples:
62		*
63		* ```php
64		* // create an object using a class name
65		* $object = $factory->create(\Yiisoft\Db\Connection::class);
66		*
67		* // create an object using a configuration array
68		* $object = $factory->create([
69		* 'class' => \Yiisoft\Db\Connection\Connection::class,
70		* '__construct()' => [
71		* 'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
72		* ],
73		* 'setUsername()' => ['root'],
74		* 'setPassword()' => [''],
75		* 'setCharset()' => ['utf8'],
76		* ]);
77		* ```
78		*
79		* Using [[Container\|dependency injection container]], this method can also identify
80		* dependent objects, instantiate them and inject them into the newly created object.
81		*
82		* @param mixed $config The object configuration. This can be specified in one of the following forms:
83		*
84		* - A string: representing the class name of the object to be created.
85		*
86		* - A configuration array: the array must contain a `class` element which is treated as the object class,
87		* and the rest of the name-value pairs will be used to initialize the corresponding object properties.
88		*
89		* - A PHP callable: either an anonymous function or an array representing a class method
90		* (`[$class or $object, $method]`). The callable should return a new instance of the object being created.
91		*
92		* @throws InvalidConfigException If the configuration is invalid.
93		* @throws CircularReferenceException
94		* @throws NotFoundException
95		* @throws NotInstantiableException
96		*
97		* @return mixed\|object The created object.
98		*
99		* @psalm-template T
100		* @psalm-param mixed\|class-string<T> $config
101		* @psalm-return ($config is class-string ? T : mixed)
102		* @psalm-suppress MixedReturnStatement
103		*/
104	85	public function create($config)
105		{
106	85	if ($this->validate) {
107	81	DefinitionValidator::validate($config);
108		}
109
110	81	if (is_string($config)) {
111	62	if ($this->factoryContainer->hasDefinition($config)) {
112	59	return $this->factoryContainer->get($config);
113		}
114	3	throw new NotFoundException($config);
115		}
116
117	21	$definition = $this->createDefinition($config);
118
119	20	if ($definition instanceof ArrayDefinition) {
120	18	$definition->setReferenceContainer($this->factoryContainer);
121		}
122		try {
123	20	$container = ($this->container === null \|\| $definition instanceof ReferenceInterface) ? $this->factoryContainer : $this->container;
124	20	return $definition->resolve($container);
125		} finally {
126	20	if ($definition instanceof ArrayDefinition) {
127	20	$definition->setReferenceContainer(null);
128		}
129		}
130		}
131
132		/**
133		* Sets a definition to the factory.
134		*
135		* @param mixed $definition
136		*
137		* @throws InvalidConfigException
138		*/
139	56	public function set(string $id, $definition): void
140		{
141	56	if ($this->validate) {
142	53	DefinitionValidator::validate($definition, $id);
143		}
144
145	53	$this->factoryContainer->setDefinition($id, $definition);
146	53	}
147
148		/**
149		* Sets multiple definitions at once.
150		*
151		* @param array $definitions definitions indexed by their ids
152		*
153		* @psalm-param array<string, mixed> $definitions
154		*
155		* @throws InvalidConfigException
156		*/
157	88	public function setMultiple(array $definitions): void
158		{
159		/** @var mixed $definition */
160	88	foreach ($definitions as $id => $definition) {
161	54	$this->set($id, $definition);
162		}
163	86	}
164
165		/**
166		* @param mixed $config
167		*
168		* @throws InvalidConfigException
169		*/
170	21	private function createDefinition($config): DefinitionInterface
171		{
172	21	$definition = Normalizer::normalize($config);
173
174		if (
175	20	($definition instanceof ArrayDefinition) &&
176	20	$this->factoryContainer->hasDefinition($definition->getClass()) &&
177	20	($containerDefinition = $this->factoryContainer->getDefinition($definition->getClass())) instanceof ArrayDefinition
178		) {
179	18	$definition = $this->mergeDefinitions(
180	18	$containerDefinition,
181		$definition
182		);
183		}
184
185	20	return $definition;
186		}
187
188	18	private function mergeDefinitions(DefinitionInterface $one, ArrayDefinition $two): DefinitionInterface
189		{
190	18	return $one instanceof ArrayDefinition ? $one->merge($two) : $two;
191		}
192		}
193

yiisoft / factory

Pull Request — master (#146)

Factory::createDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like