StateBinder::bindInjector() - Code Metrics - Inspection of "[spiral/core] Throw an exception on rebinding of a..." - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#955)

by Maxim

created 2023-08-03 11:42 UTC

StateBinder::bindInjector() A

↳ Parent: StateBinder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?php

declare(strict_types=1);

namespace Spiral\Core\Internal\Config;

use Exception;
use InvalidArgumentException;
use Spiral\Core\BinderInterface;
use Spiral\Core\Config\Alias;
use Spiral\Core\Config\Binding;
use Spiral\Core\Config\Factory;
use Spiral\Core\Config\Inflector;
use Spiral\Core\Config\Injectable;
use Spiral\Core\Config\Scalar;
use Spiral\Core\Config\Shared;
use Spiral\Core\Config\DeferredFactory;
use Spiral\Core\Container\Autowire;
use Spiral\Core\Container\InjectableInterface;
use Spiral\Core\Exception\Binder\SingletonOverloadException;
use Spiral\Core\Exception\ConfiguratorException;
use Spiral\Core\Exception\Container\ContainerException;
use Spiral\Core\Internal\State;
use Throwable;
use WeakReference;

/**
 * @psalm-import-type TResolver from BinderInterface
 * @internal
 */
class StateBinder implements BinderInterface
{
    public function __construct(
        protected readonly State $state,
    ) {
    }

    /**
     * @param TResolver|object $resolver
filter:
    dependency_paths: ["lib/*"]
     */
    public function bind(string $alias, mixed $resolver): void
    {
        if ($resolver instanceof Inflector && (\interface_exists($alias) || \class_exists($alias))) {
            $this->state->inflectors[$alias][] = $resolver;
            return;
        }

        try {
            $config = $this->makeConfig($resolver, false);
        } catch (\Throwable $e) {
            throw $this->invalidBindingException($alias, $e);
        }

        $this->setBinding($alias, $config);
    }

    /**
     * @param TResolver|object $resolver
     */
    public function bindSingleton(string $alias, mixed $resolver): void
    {
        try {
            $config = $this->makeConfig($resolver, true);
        } catch (\Throwable $e) {
            throw $this->invalidBindingException($alias, $e);
        }

        $this->setBinding($alias, $config);
    }

    public function hasInstance(string $alias): bool
    {
        $bindings = &$this->state->bindings;

        $flags = [];
        while ($binding = $bindings[$alias] ?? null and $binding::class === Alias::class) {
            //Checking alias tree
            if ($flags[$binding->alias] ?? false) {
                return $binding->alias === $alias ?: throw new Exception('Circular alias detected');
            }

            $flags[$binding->alias] = true;
            $alias = $binding->alias;
        }

        return isset($bindings[$alias]) && \is_object($bindings[$alias]);
    }

    public function removeBinding(string $alias): void
    {
        unset($this->state->bindings[$alias], $this->state->singletons[$alias]);
    }

    public function bindInjector(string $class, string $injector): void
    {
        $this->state->bindings[$class] = new Injectable($injector);
        $this->state->injectors[$class] = $injector;
    }

    public function removeInjector(string $class): void
    {
        unset($this->state->injectors[$class]);
        if (!isset($this->state->bindings[$class]) || $this->state->bindings[$class]::class !== Injectable::class) {
            return;
        }
        unset($this->state->bindings[$class]);
    }

    public function hasInjector(string $class): bool
    {
        try {
            $reflection = new \ReflectionClass($class);
        } catch (\ReflectionException $e) {
            throw new ContainerException($e->getMessage(), $e->getCode(), $e);
        }

        if (\array_key_exists($class, $this->state->injectors)) {
            return true;
        }

        if (
            $reflection->implementsInterface(InjectableInterface::class)
            && $reflection->hasConstant('INJECTOR')
        ) {
            $const = $reflection->getConstant('INJECTOR');
            $this->bindInjector($class, $const);

            return true;
        }

        // check interfaces
        foreach ($this->state->injectors as $target => $injector) {
            if (
                (\class_exists($target, true) && $reflection->isSubclassOf($target))
                ||
                (\interface_exists($target, true) && $reflection->implementsInterface($target))
            ) {
                $this->state->bindings[$class] = new Injectable($injector);

                return true;
            }
        }

        return false;
    }

    private function makeConfig(mixed $resolver, bool $singleton): Binding
    {
        return match (true) {
            $resolver instanceof Binding => $resolver,
            $resolver instanceof \Closure => new Factory($resolver, $singleton),
            $resolver instanceof Autowire => new \Spiral\Core\Config\Autowire($resolver, $singleton),
            $resolver instanceof WeakReference => new \Spiral\Core\Config\WeakReference($resolver),
            \is_string($resolver) => new Alias($resolver, $singleton),
            \is_scalar($resolver) => new Scalar($resolver),
            \is_object($resolver) => new Shared($resolver),
            \is_array($resolver) => $this->makeConfigFromArray($resolver, $singleton),
            default => throw new InvalidArgumentException('Unknown resolver type.'),
        };
    }

    private function makeConfigFromArray(array $resolver, bool $singleton): Binding
    {
        if (\is_callable($resolver)) {
            return new Factory($resolver, $singleton);
        }

        // Validate lazy invokable array
        if (!isset($resolver[0]) || !isset($resolver[1]) || !\is_string($resolver[1]) || $resolver[1] === '') {
            throw new InvalidArgumentException('Incompatible array declaration for resolver.');
        }
        if ((!\is_string($resolver[0]) && !\is_object($resolver[0])) || $resolver[0] === '') {
            throw new InvalidArgumentException('Incompatible array declaration for resolver.');
        }

        return new DeferredFactory($resolver, $singleton);
    }

    private function invalidBindingException(string $alias, Throwable $previous): Throwable
    {
        return new ConfiguratorException(\sprintf(
            'Invalid binding for `%s`. %s',
            $alias,
            $previous->getMessage(),
        ), previous: $previous);
    }

    private function setBinding(string $alias, Binding $config): void
    {
        if (isset($this->state->singletons[$alias])) {
            throw new SingletonOverloadException($alias);
        }

        $this->state->bindings[$alias] = $config;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Spiral\Core\Internal\Config;
6
7		use Exception;
8		use InvalidArgumentException;
9		use Spiral\Core\BinderInterface;
10		use Spiral\Core\Config\Alias;
11		use Spiral\Core\Config\Binding;
12		use Spiral\Core\Config\Factory;
13		use Spiral\Core\Config\Inflector;
14		use Spiral\Core\Config\Injectable;
15		use Spiral\Core\Config\Scalar;
16		use Spiral\Core\Config\Shared;
17		use Spiral\Core\Config\DeferredFactory;
18		use Spiral\Core\Container\Autowire;
19		use Spiral\Core\Container\InjectableInterface;
20		use Spiral\Core\Exception\Binder\SingletonOverloadException;
21		use Spiral\Core\Exception\ConfiguratorException;
22		use Spiral\Core\Exception\Container\ContainerException;
23		use Spiral\Core\Internal\State;
24		use Throwable;
25		use WeakReference;
26
27		/**
28		* @psalm-import-type TResolver from BinderInterface
29		* @internal
30		*/
31		class StateBinder implements BinderInterface
32		{
33	1136	public function __construct(
34		protected readonly State $state,
35		) {
36	1136	}
37
38		/**
39		* @param TResolver\|object $resolver
		0 ignored issues – show Bug introduced 2023-02-03 20:45 UTC by Report Bug Copy Issue Report The type `Spiral\Core\Internal\Config\TResolver` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
40		*/
41	849	public function bind(string $alias, mixed $resolver): void
42		{
43	849	if ($resolver instanceof Inflector && (\interface_exists($alias) \|\| \class_exists($alias))) {
44	5	$this->state->inflectors[$alias][] = $resolver;
45	5	return;
46		}
47
48		try {
49	845	$config = $this->makeConfig($resolver, false);
50	1	} catch (\Throwable $e) {
51	1	throw $this->invalidBindingException($alias, $e);
52		}
53
54	844	$this->setBinding($alias, $config);
55		}
56
57		/**
58		* @param TResolver\|object $resolver
59		*/
60	621	public function bindSingleton(string $alias, mixed $resolver): void
61		{
62		try {
63	621	$config = $this->makeConfig($resolver, true);
64		} catch (\Throwable $e) {
65		throw $this->invalidBindingException($alias, $e);
66		}
67
68	621	$this->setBinding($alias, $config);
69		}
70
71	9	public function hasInstance(string $alias): bool
72		{
73	9	$bindings = &$this->state->bindings;
74
75	9	$flags = [];
76	9	while ($binding = $bindings[$alias] ?? null and $binding::class === Alias::class) {
77		//Checking alias tree
78	2	if ($flags[$binding->alias] ?? false) {
79	1	return $binding->alias === $alias ?: throw new Exception('Circular alias detected');
80		}
81
82	2	$flags[$binding->alias] = true;
83	2	$alias = $binding->alias;
84		}
85
86	8	return isset($bindings[$alias]) && \is_object($bindings[$alias]);
87		}
88
89	3	public function removeBinding(string $alias): void
90		{
91	3	unset($this->state->bindings[$alias], $this->state->singletons[$alias]);
92		}
93
94	403	public function bindInjector(string $class, string $injector): void
95		{
96	403	$this->state->bindings[$class] = new Injectable($injector);
97	403	$this->state->injectors[$class] = $injector;
98		}
99
100		public function removeInjector(string $class): void
101		{
102		unset($this->state->injectors[$class]);
103		if (!isset($this->state->bindings[$class]) \|\| $this->state->bindings[$class]::class !== Injectable::class) {
104		return;
105		}
106		unset($this->state->bindings[$class]);
107		}
108
109	750	public function hasInjector(string $class): bool
110		{
111		try {
112	750	$reflection = new \ReflectionClass($class);
113		} catch (\ReflectionException $e) {
114		throw new ContainerException($e->getMessage(), $e->getCode(), $e);
115		}
116
117	750	if (\array_key_exists($class, $this->state->injectors)) {
118	6	return true;
119		}
120
121		if (
122	750	$reflection->implementsInterface(InjectableInterface::class)
123	750	&& $reflection->hasConstant('INJECTOR')
124		) {
125	394	$const = $reflection->getConstant('INJECTOR');
126	394	$this->bindInjector($class, $const);
127
128	394	return true;
129		}
130
131		// check interfaces
132	746	foreach ($this->state->injectors as $target => $injector) {
133		if (
134	386	(\class_exists($target, true) && $reflection->isSubclassOf($target))
135		\|\|
136	386	(\interface_exists($target, true) && $reflection->implementsInterface($target))
137		) {
138	7	$this->state->bindings[$class] = new Injectable($injector);
139
140	7	return true;
141		}
142		}
143
144	743	return false;
145		}
146
147	908	private function makeConfig(mixed $resolver, bool $singleton): Binding
148		{
149	908	return match (true) {
150	908	$resolver instanceof Binding => $resolver,
151	908	$resolver instanceof \Closure => new Factory($resolver, $singleton),
152	908	$resolver instanceof Autowire => new \Spiral\Core\Config\Autowire($resolver, $singleton),
153	908	$resolver instanceof WeakReference => new \Spiral\Core\Config\WeakReference($resolver),
154	908	\is_string($resolver) => new Alias($resolver, $singleton),
155	908	\is_scalar($resolver) => new Scalar($resolver),
156	908	\is_object($resolver) => new Shared($resolver),
157	908	\is_array($resolver) => $this->makeConfigFromArray($resolver, $singleton),
158	908	default => throw new InvalidArgumentException('Unknown resolver type.'),
159	908	};
160		}
161
162	407	private function makeConfigFromArray(array $resolver, bool $singleton): Binding
163		{
164	407	if (\is_callable($resolver)) {
165		return new Factory($resolver, $singleton);
166		}
167
168		// Validate lazy invokable array
169	407	if (!isset($resolver[0]) \|\| !isset($resolver[1]) \|\| !\is_string($resolver[1]) \|\| $resolver[1] === '') {
170		throw new InvalidArgumentException('Incompatible array declaration for resolver.');
171		}
172	407	if ((!\is_string($resolver[0]) && !\is_object($resolver[0])) \|\| $resolver[0] === '') {
173		throw new InvalidArgumentException('Incompatible array declaration for resolver.');
174		}
175
176	407	return new DeferredFactory($resolver, $singleton);
177		}
178
179	1	private function invalidBindingException(string $alias, Throwable $previous): Throwable
180		{
181	1	return new ConfiguratorException(\sprintf(
182	1	'Invalid binding for `%s`. %s',
183	1	$alias,
184	1	$previous->getMessage(),
185	1	), previous: $previous);
186		}
187
188	907	private function setBinding(string $alias, Binding $config): void
189		{
190	907	if (isset($this->state->singletons[$alias])) {
191	1	throw new SingletonOverloadException($alias);
192		}
193
194	907	$this->state->bindings[$alias] = $config;
195		}
196		}
197

spiral / framework

Pull Request — master (#955)

StateBinder::bindInjector() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like