Container::validateDefinition() - Code Metrics - Inspection of "improve" - yiisoft/di - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — suggestion ( e78e97 )

by Sergei

created 2021-11-25 14:51 UTC

Container::validateDefinition() A

↳ Parent: Container

Complexity

Conditions	5
Paths	4

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5.0187

Importance

Changes

Metric	Value
cc	5
eloc	11
nc	4
nop	2
dl	0
loc	18
ccs	10
cts	11
cp	0.9091
crap	5.0187
rs	9.6111
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Di;

use Closure;
use InvalidArgumentException;
use Psr\Container\ContainerInterface;
use Yiisoft\Definitions\ArrayDefinition;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Definitions\Helpers\DefinitionValidator;
use Yiisoft\Definitions\DefinitionStorage;

use function array_key_exists;
use function array_keys;
use function get_class;
use function gettype;
use function implode;
use function in_array;
use function is_array;
use function is_object;
use function is_string;

/**
 * Container implements a [dependency injection](http://en.wikipedia.org/wiki/Dependency_injection) container.
 */
final class Container implements ContainerInterface
{
    private const META_TAGS = 'tags';
    private const META_RESET = 'reset';
    private const ALLOWED_META = [self::META_TAGS, self::META_RESET];

    /**
     * @var DefinitionStorage Storage of object definitions.
     */
    private DefinitionStorage $definitions;
    /**
     * @var array Used to collect IDs of objects instantiated during build
     * to detect circular references.
     */
    private array $building = [];

    /**
     * @var bool $validate If definitions should be validated.
     */
    private bool $validate;

    /**
     * @var object[]
     */
    private array $instances = [];

    private CompositeContainer $delegates;

    /**
     * @var array Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
     */
    private array $tags;

    private array $resetters = [];

    /**
     * Container constructor.
     *
     * @param ContainerConfigInterface|null $config Container configuration.
     *
     * @throws InvalidConfigException
     * @psalm-suppress PropertyNotSetInConstructor
     */
    public function __construct(?ContainerConfigInterface $config = null)
    {
        $config ??= ContainerConfig::create();

        $this->definitions = new DefinitionStorage();
        $this->tags = $config->getTags();
        $this->validate = $config->shouldValidate();
        $this->setDefaultDefinitions();
        $this->setMultiple($config->getDefinitions());
        $this->addProviders($config->getProviders());
        $this->setDelegates($config->getDelegates());
    }

    /**
     * Returns a value indicating whether the container has the definition of the specified name.
     *
     * @param string $id Class name, interface name or alias name.
     *
     * @return bool Whether the container is able to provide instance of class specified.
     *
     * @see set()
     */
    public function has($id): bool
    {
        /** @psalm-suppress  DocblockTypeContradiction */
        if (!is_string($id)) {

            return false;
        }

        if ($this->isTagAlias($id)) {
            $tag = substr($id, 4);
            return isset($this->tags[$tag]);
        }

        try {
            return $this->definitions->has($id);
        } catch (CircularReferenceException $e) {
            return true;
        }
    }

    /**
     * Returns an instance by either interface name or alias.
     *
     * Same instance of the class will be returned each time this method is called.
     *
     * @param string $id The interface or an alias name that was previously registered.
     *
     * @throws CircularReferenceException
     * @throws InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     *
     * @return mixed|object An instance of the requested interface.
     *
     * @psalm-template T
     * @psalm-param string|class-string<T> $id
     * @psalm-return ($id is class-string ? T : mixed)
     */
    public function get($id)
    {
        /** @psalm-suppress TypeDoesNotContainType */
        if (!is_string($id)) {

            throw new InvalidArgumentException("Id must be a string, {$this->getVariableType($id)} given.");
        }

        if (!array_key_exists($id, $this->instances)) {
            try {
                $this->instances[$id] = $this->build($id);
            } catch (NotFoundException $e) {
                if (!$this->delegates->has($id)) {
                    throw $e;
                }

                return $this->delegates->get($id);
            }
        }

        if ($id === StateResetter::class && $this->definitions->get($id) === StateResetter::class) {
            $resetters = [];
            foreach ($this->resetters as $serviceId => $callback) {
                if (isset($this->instances[$serviceId])) {
                    $resetters[$serviceId] = $callback;
                }
            }
            if ($this->delegates->has(StateResetter::class)) {
                $resetters[] = $this->delegates->get(StateResetter::class);
            }
            $this->instances[$id]->setResetters($resetters);
        }

        return $this->instances[$id];
    }

    /**
     * Sets a definition to the container. Definition may be defined multiple ways.
     *
     * @param string $id ID to set definition for.
     * @param mixed $definition Definition to set.
     *
     * @throws InvalidConfigException
     *
     * @see DefinitionNormalizer::normalize()
     */
    private function set(string $id, $definition): void
    {
        [$definition, $meta] = DefinitionParser::parse($definition);
        if ($this->validate) {
            $this->validateDefinition($definition, $id);
            $this->validateMeta($meta);
        }

        if (isset($meta[self::META_TAGS])) {
            if ($this->validate) {
                $this->validateTags($meta[self::META_TAGS]);
            }
            $this->setTags($id, $meta[self::META_TAGS]);
        }
        if (isset($meta[self::META_RESET])) {
            $this->setResetter($id, $meta[self::META_RESET]);
        }

        unset($this->instances[$id]);
        $this->definitions->set($id, $definition);
    }

    /**
     * Sets multiple definitions at once.
     *
     * @param array $config Definitions indexed by their IDs.
     *
     * @throws InvalidConfigException
     */
    private function setMultiple(array $config): void
    {
        foreach ($config as $id => $definition) {
            if ($this->validate && !is_string($id)) {
                throw new InvalidConfigException(sprintf('Key must be a string. %s given.', $this->getVariableType($id)));
            }
            $this->set($id, $definition);
        }
    }

    private function setDefaultDefinitions(): void
    {
        $this->setMultiple([
            ContainerInterface::class => $this,
            StateResetter::class => StateResetter::class,
        ]);
    }

    /**
     * Set container delegates.
     *
     * Each delegate must is a callable in format "function (ContainerInterface $container): ContainerInterface".
     * The container instance returned is used in case a service can not be found in primary container.
     *
     * @param array $delegates
     *
     * @throws InvalidConfigException
     */
    private function setDelegates(array $delegates): void
    {
        $this->delegates = new CompositeContainer();
        foreach ($delegates as $delegate) {
            if (!$delegate instanceof Closure) {
                throw new InvalidConfigException(
                    'Delegate must be callable in format "function (ContainerInterface $container): ContainerInterface".'
                );
            }

            $delegate = $delegate($this);

            if (!$delegate instanceof ContainerInterface) {
                throw new InvalidConfigException(
                    'Delegate callable must return an object that implements ContainerInterface.'
                );
            }

            $this->delegates->attach($delegate);
        }
        $this->definitions->setDelegateContainer($this->delegates);
    }

    /**
     * @param mixed $definition Definition to validate.
     * @param string|null $id ID of the definition to validate.
     *
     * @throws InvalidConfigException
     */
    private function validateDefinition($definition, ?string $id = null): void
    {
        if (is_array($definition) && isset($definition[DefinitionParser::IS_PREPARED_ARRAY_DEFINITION_DATA])) {
            $class = $definition['class'];
            $constructorArguments = $definition['__construct()'];
            $methodsAndProperties = $definition['methodsAndProperties'];
            $definition = array_merge(
                $class === null ? [] : [ArrayDefinition::CLASS_NAME => $class],
                [ArrayDefinition::CONSTRUCTOR => $constructorArguments],
                $methodsAndProperties,
            );
        }

        if ($definition instanceof ExtensibleService) {
            throw new InvalidConfigException('Invalid definition. ExtensibleService is only allowed in provider extensions.');
        }

        DefinitionValidator::validate($definition, $id);
    }

    /**
     * @throws InvalidConfigException
     */
    private function validateMeta(array $meta): void
    {
        foreach ($meta as $key => $_value) {
            if (!in_array($key, self::ALLOWED_META, true)) {
                throw new InvalidConfigException(
                    sprintf(
                        'Invalid definition: metadata "%s" is not allowed. Did you mean "%s()" or "$%s"?',
                        $key,
                        $key,
                        $key,
                    )
                );
            }
        }
    }

    private function validateTags(array $tags): void
    {
        foreach ($tags as $tag) {
            if (!is_string($tag)) {
                throw new InvalidConfigException('Invalid tag. Expected a string, got ' . var_export($tag, true) . '.');
            }
        }
    }

    private function setTags(string $id, array $tags): void
    {
        foreach ($tags as $tag) {
            if (!isset($this->tags[$tag]) || !in_array($id, $this->tags[$tag], true)) {
                $this->tags[$tag][] = $id;
            }
        }
    }

    private function setResetter(string $id, Closure $resetter): void
    {
        $this->resetters[$id] = $resetter;
    }

    /**
     * Creates new instance by either interface name or alias.
     *
     * @param string $id The interface or an alias name that was previously registered.
     *
     * @throws CircularReferenceException
     * @throws InvalidConfigException
     * @throws NotFoundException
     *
     * @return mixed|object New built instance of the specified class.
     *
     * @internal
     */
    private function build(string $id)
    {
        if ($this->isTagAlias($id)) {
            return $this->getTaggedServices($id);
        }

        if (isset($this->building[$id])) {
            if ($id === ContainerInterface::class) {
                return $this;
            }
            throw new CircularReferenceException(sprintf(
                'Circular reference to "%s" detected while building: %s.',
                $id,
                implode(', ', array_keys($this->building))
            ));
        }

        $this->building[$id] = 1;
        try {
            $object = $this->buildInternal($id);
        } finally {
            unset($this->building[$id]);
        }

        return $object;
    }

    private function isTagAlias(string $id): bool
    {
        return strncmp($id, 'tag@', 4) === 0;
    }

    private function getTaggedServices(string $tagAlias): array
    {
        $tag = substr($tagAlias, 4);
        $services = [];
        if (isset($this->tags[$tag])) {
            foreach ($this->tags[$tag] as $service) {
                $services[] = $this->get($service);
            }
        }

        return $services;
    }

    /**
     * @param string $id
     *
     * @throws InvalidConfigException
     * @throws NotFoundException
     *
     * @return mixed|object
     */
    private function buildInternal(string $id)
    {
        if ($this->definitions->has($id)) {
            $definition = DefinitionNormalizer::normalize($this->definitions->get($id), $id);

            return $definition->resolve($this->get(ContainerInterface::class));
        }

        throw new NotFoundException($id, $this->definitions->getBuildStack());
    }

    private function addProviders(array $providers): void
    {
        $extensions = [];
        foreach ($providers as $provider) {
            $providerInstance = $this->buildProvider($provider);
            $extensions[] = $providerInstance->getExtensions();
            $this->addProviderDefinitions($providerInstance);
        }

        foreach ($extensions as $providerExtensions) {
            foreach ($providerExtensions as $id => $extension) {
                if (!$this->definitions->has($id)) {
                    throw new InvalidConfigException("Extended service \"$id\" doesn't exist.");
                }

                $definition = $this->definitions->get($id);
                if (!$definition instanceof ExtensibleService) {
                    $definition = new ExtensibleService($definition);
                    $this->definitions->set($id, $definition);
                }

                $definition->addExtension($extension);
            }
        }
    }

    /**
     * Adds service provider definitions to the container.
     *
     * @param ServiceProviderInterface $provider Provider to get definitions from.
     *
     * @throws InvalidConfigException
     * @throws NotInstantiableException
     */
    private function addProviderDefinitions(ServiceProviderInterface $provider): void
    {
        $definitions = $provider->getDefinitions();
        $this->setMultiple($definitions);
    }

    /**
     * Builds service provider by definition.
     *
     * @param mixed $provider Class name or instance of provider.
     *
     * @throws InvalidConfigException If provider argument is not valid.
     *
     * @return ServiceProviderInterface Instance of service provider.
     *
     * @psalm-suppress MoreSpecificReturnType
     */
    private function buildProvider($provider): ServiceProviderInterface
    {
        if ($this->validate && !(is_string($provider) || $provider instanceof ServiceProviderInterface)) {
            throw new InvalidConfigException(
                sprintf(
                    'Service provider should be a class name or an instance of %s. %s given.',
                    ServiceProviderInterface::class,
                    $this->getVariableType($provider)
                )
            );
        }

        $providerInstance = is_object($provider) ? $provider : new $provider();
        if (!$providerInstance instanceof ServiceProviderInterface) {
            throw new InvalidConfigException(
                sprintf(
                    'Service provider should be an instance of %s. %s given.',
                    ServiceProviderInterface::class,
                    $this->getVariableType($providerInstance)
                )
            );
        }

        /**
         * @psalm-suppress LessSpecificReturnStatement
         */
        return $providerInstance;
    }

    /**
     * @param mixed $variable
     */
    private function getVariableType($variable): string
    {
        return is_object($variable) ? get_class($variable) : gettype($variable);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Di;
6
7		use Closure;
8		use InvalidArgumentException;
9		use Psr\Container\ContainerInterface;
10		use Yiisoft\Definitions\ArrayDefinition;
11		use Yiisoft\Definitions\Exception\CircularReferenceException;
12		use Yiisoft\Definitions\Exception\InvalidConfigException;
13		use Yiisoft\Definitions\Exception\NotInstantiableException;
14		use Yiisoft\Definitions\Helpers\DefinitionValidator;
15		use Yiisoft\Definitions\DefinitionStorage;
16
17		use function array_key_exists;
18		use function array_keys;
19		use function get_class;
20		use function gettype;
21		use function implode;
22		use function in_array;
23		use function is_array;
24		use function is_object;
25		use function is_string;
26
27		/**
28		* Container implements a [dependency injection](http://en.wikipedia.org/wiki/Dependency_injection) container.
29		*/
30		final class Container implements ContainerInterface
31		{
32		private const META_TAGS = 'tags';
33		private const META_RESET = 'reset';
34		private const ALLOWED_META = [self::META_TAGS, self::META_RESET];
35
36		/**
37		* @var DefinitionStorage Storage of object definitions.
38		*/
39		private DefinitionStorage $definitions;
40		/**
41		* @var array Used to collect IDs of objects instantiated during build
42		* to detect circular references.
43		*/
44		private array $building = [];
45
46		/**
47		* @var bool $validate If definitions should be validated.
48		*/
49		private bool $validate;
50
51		/**
52		* @var object[]
53		*/
54		private array $instances = [];
55
56		private CompositeContainer $delegates;
57
58		/**
59		* @var array Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
60		*/
61		private array $tags;
62
63		private array $resetters = [];
64
65		/**
66		* Container constructor.
67		*
68		* @param ContainerConfigInterface\|null $config Container configuration.
69		*
70		* @throws InvalidConfigException
71		* @psalm-suppress PropertyNotSetInConstructor
72		*/
73	95	public function __construct(?ContainerConfigInterface $config = null)
74		{
75	95	$config ??= ContainerConfig::create();
76
77	95	$this->definitions = new DefinitionStorage();
78	95	$this->tags = $config->getTags();
79	95	$this->validate = $config->shouldValidate();
80	95	$this->setDefaultDefinitions();
81	95	$this->setMultiple($config->getDefinitions());
82	89	$this->addProviders($config->getProviders());
83	88	$this->setDelegates($config->getDelegates());
84	88	}
85
86		/**
87		* Returns a value indicating whether the container has the definition of the specified name.
88		*
89		* @param string $id Class name, interface name or alias name.
90		*
91		* @return bool Whether the container is able to provide instance of class specified.
92		*
93		* @see set()
94		*/
95	26	public function has($id): bool
96		{
97		/** @psalm-suppress DocblockTypeContradiction */
98	26	if (!is_string($id)) {
		0 ignored issues – show introduced 2021-08-10 08:46 UTC by Report Bug Copy Issue Report The condition `is_string($id)` is always `true`. Loading history...
99		return false;
100		}
101
102	26	if ($this->isTagAlias($id)) {
103	2	$tag = substr($id, 4);
104	2	return isset($this->tags[$tag]);
105		}
106
107		try {
108	24	return $this->definitions->has($id);
109	2	} catch (CircularReferenceException $e) {
110	2	return true;
111		}
112		}
113
114		/**
115		* Returns an instance by either interface name or alias.
116		*
117		* Same instance of the class will be returned each time this method is called.
118		*
119		* @param string $id The interface or an alias name that was previously registered.
120		*
121		* @throws CircularReferenceException
122		* @throws InvalidConfigException
123		* @throws NotFoundException
124		* @throws NotInstantiableException
125		*
126		* @return mixed\|object An instance of the requested interface.
127		*
128		* @psalm-template T
129		* @psalm-param string\|class-string<T> $id
130		* @psalm-return ($id is class-string ? T : mixed)
131		*/
132	83	public function get($id)
133		{
134		/** @psalm-suppress TypeDoesNotContainType */
135	83	if (!is_string($id)) {
		0 ignored issues – show introduced 2021-08-10 08:46 UTC by Report Bug Copy Issue Report The condition `is_string($id)` is always `true`. Loading history...
136		throw new InvalidArgumentException("Id must be a string, {$this->getVariableType($id)} given.");
137		}
138
139	83	if (!array_key_exists($id, $this->instances)) {
140		try {
141	83	$this->instances[$id] = $this->build($id);
142	14	} catch (NotFoundException $e) {
143	5	if (!$this->delegates->has($id)) {
144	4	throw $e;
145		}
146
147	1	return $this->delegates->get($id);
148		}
149		}
150
151	77	if ($id === StateResetter::class && $this->definitions->get($id) === StateResetter::class) {
152	4	$resetters = [];
153	4	foreach ($this->resetters as $serviceId => $callback) {
154	4	if (isset($this->instances[$serviceId])) {
155	4	$resetters[$serviceId] = $callback;
156		}
157		}
158	4	if ($this->delegates->has(StateResetter::class)) {
159		$resetters[] = $this->delegates->get(StateResetter::class);
160		}
161	4	$this->instances[$id]->setResetters($resetters);
162		}
163
164	77	return $this->instances[$id];
165		}
166
167		/**
168		* Sets a definition to the container. Definition may be defined multiple ways.
169		*
170		* @param string $id ID to set definition for.
171		* @param mixed $definition Definition to set.
172		*
173		* @throws InvalidConfigException
174		*
175		* @see DefinitionNormalizer::normalize()
176		*/
177	95	private function set(string $id, $definition): void
178		{
179	95	[$definition, $meta] = DefinitionParser::parse($definition);
180	95	if ($this->validate) {
181	95	$this->validateDefinition($definition, $id);
182	95	$this->validateMeta($meta);
183		}
184
185	95	if (isset($meta[self::META_TAGS])) {
186	8	if ($this->validate) {
187	8	$this->validateTags($meta[self::META_TAGS]);
188		}
189	8	$this->setTags($id, $meta[self::META_TAGS]);
190		}
191	95	if (isset($meta[self::META_RESET])) {
192	5	$this->setResetter($id, $meta[self::META_RESET]);
193		}
194
195	95	unset($this->instances[$id]);
196	95	$this->definitions->set($id, $definition);
197	95	}
198
199		/**
200		* Sets multiple definitions at once.
201		*
202		* @param array $config Definitions indexed by their IDs.
203		*
204		* @throws InvalidConfigException
205		*/
206	95	private function setMultiple(array $config): void
207		{
208	95	foreach ($config as $id => $definition) {
209	95	if ($this->validate && !is_string($id)) {
210	1	throw new InvalidConfigException(sprintf('Key must be a string. %s given.', $this->getVariableType($id)));
211		}
212	95	$this->set($id, $definition);
213		}
214	95	}
215
216	95	private function setDefaultDefinitions(): void
217		{
218	95	$this->setMultiple([
219	95	ContainerInterface::class => $this,
220		StateResetter::class => StateResetter::class,
221		]);
222	95	}
223
224		/**
225		* Set container delegates.
226		*
227		* Each delegate must is a callable in format "function (ContainerInterface $container): ContainerInterface".
228		* The container instance returned is used in case a service can not be found in primary container.
229		*
230		* @param array $delegates
231		*
232		* @throws InvalidConfigException
233		*/
234	88	private function setDelegates(array $delegates): void
235		{
236	88	$this->delegates = new CompositeContainer();
237	88	foreach ($delegates as $delegate) {
238	1	if (!$delegate instanceof Closure) {
239		throw new InvalidConfigException(
240		'Delegate must be callable in format "function (ContainerInterface $container): ContainerInterface".'
241		);
242		}
243
244	1	$delegate = $delegate($this);
245
246	1	if (!$delegate instanceof ContainerInterface) {
247		throw new InvalidConfigException(
248		'Delegate callable must return an object that implements ContainerInterface.'
249		);
250		}
251
252	1	$this->delegates->attach($delegate);
253		}
254	88	$this->definitions->setDelegateContainer($this->delegates);
255	88	}
256
257		/**
258		* @param mixed $definition Definition to validate.
259		* @param string\|null $id ID of the definition to validate.
260		*
261		* @throws InvalidConfigException
262		*/
263	95	private function validateDefinition($definition, ?string $id = null): void
264		{
265	95	if (is_array($definition) && isset($definition[DefinitionParser::IS_PREPARED_ARRAY_DEFINITION_DATA])) {
266	36	$class = $definition['class'];
267	36	$constructorArguments = $definition['__construct()'];
268	36	$methodsAndProperties = $definition['methodsAndProperties'];
269	36	$definition = array_merge(
270	36	$class === null ? [] : [ArrayDefinition::CLASS_NAME => $class],
271	36	[ArrayDefinition::CONSTRUCTOR => $constructorArguments],
272		$methodsAndProperties,
273		);
274		}
275
276	95	if ($definition instanceof ExtensibleService) {
277		throw new InvalidConfigException('Invalid definition. ExtensibleService is only allowed in provider extensions.');
278		}
279
280	95	DefinitionValidator::validate($definition, $id);
281	95	}
282
283		/**
284		* @throws InvalidConfigException
285		*/
286	95	private function validateMeta(array $meta): void
287		{
288	95	foreach ($meta as $key => $_value) {
289	16	if (!in_array($key, self::ALLOWED_META, true)) {
290	3	throw new InvalidConfigException(
291	3	sprintf(
292	3	'Invalid definition: metadata "%s" is not allowed. Did you mean "%s()" or "$%s"?',
293		$key,
294		$key,
295		$key,
296		)
297		);
298		}
299		}
300	95	}
301
302	8	private function validateTags(array $tags): void
303		{
304	8	foreach ($tags as $tag) {
305	8	if (!is_string($tag)) {
306		throw new InvalidConfigException('Invalid tag. Expected a string, got ' . var_export($tag, true) . '.');
307		}
308		}
309	8	}
310
311	8	private function setTags(string $id, array $tags): void
312		{
313	8	foreach ($tags as $tag) {
314	8	if (!isset($this->tags[$tag]) \|\| !in_array($id, $this->tags[$tag], true)) {
315	8	$this->tags[$tag][] = $id;
316		}
317		}
318	8	}
319
320	4	private function setResetter(string $id, Closure $resetter): void
321		{
322	4	$this->resetters[$id] = $resetter;
323	4	}
324
325		/**
326		* Creates new instance by either interface name or alias.
327		*
328		* @param string $id The interface or an alias name that was previously registered.
329		*
330		* @throws CircularReferenceException
331		* @throws InvalidConfigException
332		* @throws NotFoundException
333		*
334		* @return mixed\|object New built instance of the specified class.
335		*
336		* @internal
337		*/
338	83	private function build(string $id)
339		{
340	83	if ($this->isTagAlias($id)) {
341	9	return $this->getTaggedServices($id);
342		}
343
344	82	if (isset($this->building[$id])) {
345	76	if ($id === ContainerInterface::class) {
346	76	return $this;
347		}
348	4	throw new CircularReferenceException(sprintf(
349	4	'Circular reference to "%s" detected while building: %s.',
350		$id,
351	4	implode(', ', array_keys($this->building))
352		));
353		}
354
355	82	$this->building[$id] = 1;
356		try {
357	82	$object = $this->buildInternal($id);
358	76	} finally {
359	82	unset($this->building[$id]);
360		}
361
362	76	return $object;
363		}
364
365	88	private function isTagAlias(string $id): bool
366		{
367	88	return strncmp($id, 'tag@', 4) === 0;
368		}
369
370	9	private function getTaggedServices(string $tagAlias): array
371		{
372	9	$tag = substr($tagAlias, 4);
373	9	$services = [];
374	9	if (isset($this->tags[$tag])) {
375	8	foreach ($this->tags[$tag] as $service) {
376	8	$services[] = $this->get($service);
377		}
378		}
379
380	9	return $services;
381		}
382
383		/**
384		* @param string $id
385		*
386		* @throws InvalidConfigException
387		* @throws NotFoundException
388		*
389		* @return mixed\|object
390		*/
391	82	private function buildInternal(string $id)
392		{
393	82	if ($this->definitions->has($id)) {
394	76	$definition = DefinitionNormalizer::normalize($this->definitions->get($id), $id);
395
396	76	return $definition->resolve($this->get(ContainerInterface::class));
397		}
398
399	5	throw new NotFoundException($id, $this->definitions->getBuildStack());
400		}
401
402	89	private function addProviders(array $providers): void
403		{
404	89	$extensions = [];
405	89	foreach ($providers as $provider) {
406	6	$providerInstance = $this->buildProvider($provider);
407	6	$extensions[] = $providerInstance->getExtensions();
408	6	$this->addProviderDefinitions($providerInstance);
409		}
410
411	89	foreach ($extensions as $providerExtensions) {
412	6	foreach ($providerExtensions as $id => $extension) {
413	5	if (!$this->definitions->has($id)) {
414	1	throw new InvalidConfigException("Extended service \"$id\" doesn't exist.");
415		}
416
417	5	$definition = $this->definitions->get($id);
418	5	if (!$definition instanceof ExtensibleService) {
419	5	$definition = new ExtensibleService($definition);
420	5	$this->definitions->set($id, $definition);
421		}
422
423	5	$definition->addExtension($extension);
424		}
425		}
426	88	}
427
428		/**
429		* Adds service provider definitions to the container.
430		*
431		* @param ServiceProviderInterface $provider Provider to get definitions from.
432		*
433		* @throws InvalidConfigException
434		* @throws NotInstantiableException
435		*/
436	6	private function addProviderDefinitions(ServiceProviderInterface $provider): void
437		{
438	6	$definitions = $provider->getDefinitions();
439	6	$this->setMultiple($definitions);
440	6	}
441
442		/**
443		* Builds service provider by definition.
444		*
445		* @param mixed $provider Class name or instance of provider.
446		*
447		* @throws InvalidConfigException If provider argument is not valid.
448		*
449		* @return ServiceProviderInterface Instance of service provider.
450		*
451		* @psalm-suppress MoreSpecificReturnType
452		*/
453	6	private function buildProvider($provider): ServiceProviderInterface
454		{
455	6	if ($this->validate && !(is_string($provider) \|\| $provider instanceof ServiceProviderInterface)) {
456		throw new InvalidConfigException(
457		sprintf(
458		'Service provider should be a class name or an instance of %s. %s given.',
459		ServiceProviderInterface::class,
460		$this->getVariableType($provider)
461		)
462		);
463		}
464
465	6	$providerInstance = is_object($provider) ? $provider : new $provider();
466	6	if (!$providerInstance instanceof ServiceProviderInterface) {
467		throw new InvalidConfigException(
468		sprintf(
469		'Service provider should be an instance of %s. %s given.',
470		ServiceProviderInterface::class,
471		$this->getVariableType($providerInstance)
472		)
473		);
474		}
475
476		/**
477		* @psalm-suppress LessSpecificReturnStatement
478		*/
479	6	return $providerInstance;
480		}
481
482		/**
483		* @param mixed $variable
484		*/
485	1	private function getVariableType($variable): string
486		{
487	1	return is_object($variable) ? get_class($variable) : gettype($variable);
488		}
489		}
490

yiisoft / di

Push — suggestion ( e78e97 )

Container::validateDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like