ParameterDefinition::getValueType() - Code Metrics - Inspection of "Add rector [batch]" - yiisoft/definitions - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#41)

by Sergei

created 2022-10-31 11:22 UTC

ParameterDefinition::getValueType() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Definitions;

use Psr\Container\ContainerInterface;
use ReflectionNamedType;
use ReflectionParameter;
use ReflectionUnionType;
use Throwable;
use Yiisoft\Definitions\Contract\DefinitionInterface;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Definitions\Exception\InvalidConfigException;

/**
 * Parameter definition resolves an object based on information from `ReflectionParameter` instance.
 */
final class ParameterDefinition implements DefinitionInterface
{
    public function __construct(
        private ReflectionParameter $parameter
    ) {
    }

    public function getReflection(): ReflectionParameter
    {
        return $this->parameter;
    }

    public function isVariadic(): bool
    {
        return $this->parameter->isVariadic();
    }

    public function isOptional(): bool
    {
        return $this->parameter->isOptional();
    }

    public function hasValue(): bool
    {
        return $this->parameter->isDefaultValueAvailable();
    }

    public function resolve(ContainerInterface $container): mixed
    {
        $type = $this->parameter->getType();

        if ($type === null || $this->isVariadic()) {
            return $this->resolveVariadicOrBuiltinOrNonTyped();
        }

        if ($this->isUnionType()) {
            return $this->resolveUnionType($container);
        }

        /** @var ReflectionNamedType|null $type */
        $type = $this->parameter->getType();
        $isBuiltin = $type !== null && $type->isBuiltin();

        if (!$isBuiltin) {
            /** @var ReflectionNamedType $type */
            $typeName = $type->getName();
            if ($typeName === 'self') {
                // If type name is "self", it means that called class and
                // $parameter->getDeclaringClass() returned instance of `ReflectionClass`.
                /** @psalm-suppress PossiblyNullReference */
                $typeName = $this->parameter->getDeclaringClass()->getName();
            }

            try {
                /** @var mixed */
                $result = $container->get($typeName);
            } catch (Throwable $t) {
                if (
                    $this->parameter->isOptional()
                    && (
                        $t instanceof CircularReferenceException
                        || !$container->has($typeName)
                    )
                ) {
                    return $this->parameter->getDefaultValue();
                }
                throw $t;
            }

            if (!$result instanceof $typeName) {
                $actualType = get_debug_type($result);
                throw new InvalidConfigException(
                    "Container returned incorrect type \"$actualType\" for service \"{$type->getName()}\"."
                );
            }
            return $result;
        }

        return $this->resolveVariadicOrBuiltinOrNonTyped();
    }

    /**
     * @throws NotInstantiableException
     *
     * @return mixed
     */
    private function resolveVariadicOrBuiltinOrNonTyped()
    {
        if ($this->parameter->isDefaultValueAvailable()) {
            return $this->parameter->getDefaultValue();
        }

        if ($this->isOptional()) {
            throw new NotInstantiableException(
                sprintf(
                    'Can not determine default value of parameter "%s" when instantiating "%s" ' .
                    'because it is PHP internal. Please specify argument explicitly.',
                    $this->parameter->getName(),
                    $this->getCallable(),
                )
            );
        }

        $type = $this->getType();

        if ($type === null) {
            throw new NotInstantiableException(
                sprintf(
                    'Can not determine value of the "%s" parameter without type when instantiating "%s". ' .
                    'Please specify argument explicitly.',
                    $this->parameter->getName(),
                    $this->getCallable(),
                )
            );
        }

        throw new NotInstantiableException(
            sprintf(
                'Can not determine value of the "%s" parameter of type "%s" when instantiating "%s". ' .
                'Please specify argument explicitly.',
                $this->parameter->getName(),
                $type,
                $this->getCallable(),
            )
        );
    }

    /**
     * Resolve union type string provided as a class name.
     *
     * @throws InvalidConfigException If an object of incorrect type was created.
     * @throws Throwable
     *
     * @return mixed|null Ready to use object or null if definition can
     * not be resolved and is marked as optional.
     */
    private function resolveUnionType(ContainerInterface $container)
    {
        /**
         * @var ReflectionUnionType $parameterType
         */
        $parameterType = $this->parameter->getType();

        /**
         * @var ReflectionNamedType[] $types
         */
        $types = $parameterType->getTypes();
        $class = implode('|', $types);

        foreach ($types as $type) {
            if (!$type->isBuiltin()) {
                $typeName = $type->getName();
                /**
                 * @psalm-suppress TypeDoesNotContainType
                 *
                 * @link https://github.com/vimeo/psalm/issues/6756
                 */
                if ($typeName === 'self') {
                    // If type name is "self", it means that called class and
                    // $parameter->getDeclaringClass() returned instance of `ReflectionClass`.
                    /** @psalm-suppress PossiblyNullReference */
                    $typeName = $this->parameter->getDeclaringClass()->getName();
                }

                try {
                    /** @var mixed */
                    $result = $container->get($typeName);
                    $resolved = true;
                } catch (Throwable $t) {
                    $error = $t;
                    $resolved = false;
                }

                if ($resolved) {
                    /** @var mixed $result Exist, because $resolved is true */
                    if (!$result instanceof $typeName) {
                        $actualType = get_debug_type($result);
                        throw new InvalidConfigException(
                            "Container returned incorrect type \"$actualType\" for service \"$class\"."
                        );
                    }
                    return $result;
                }

                /** @var Throwable $error Exist, because $resolved is false */
                if (
                    !$error instanceof CircularReferenceException

                    && $container->has($typeName)
                ) {
                    throw $error;
                }
            }
        }

        if ($this->parameter->isOptional()) {
            return null;
        }

        if (!isset($error)) {
            return $this->resolveVariadicOrBuiltinOrNonTyped();
        }

        throw $error;
    }

    private function isUnionType(): bool
    {
        return $this->parameter->getType() instanceof ReflectionUnionType;
    }

    private function getType(): ?string
    {
        $type = $this->parameter->getType();

        if ($type instanceof ReflectionUnionType) {
            $namedTypes = $type->getTypes();
            $names = array_map(
                static fn (ReflectionNamedType $t) => $t->getName(),
                $namedTypes
            );
            return implode('|', $names);
        }

        if ($type instanceof ReflectionNamedType) {
            return $type->getName();
        }

        return null;
    }

    private function getCallable(): string
    {
        $callable = [];

        $class = $this->parameter->getDeclaringClass();
        if ($class !== null) {
            $callable[] = $class->getName();
        }
        $callable[] = $this->parameter
                ->getDeclaringFunction()
                ->getName() .
            '()';

        return implode('::', $callable);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Definitions;
6
7		use Psr\Container\ContainerInterface;
8		use ReflectionNamedType;
9		use ReflectionParameter;
10		use ReflectionUnionType;
11		use Throwable;
12		use Yiisoft\Definitions\Contract\DefinitionInterface;
13		use Yiisoft\Definitions\Exception\CircularReferenceException;
14		use Yiisoft\Definitions\Exception\NotInstantiableException;
15		use Yiisoft\Definitions\Exception\InvalidConfigException;
16
17		/**
18		* Parameter definition resolves an object based on information from `ReflectionParameter` instance.
19		*/
20		final class ParameterDefinition implements DefinitionInterface
21		{
22	72	public function __construct(
23		private ReflectionParameter $parameter
24		) {
25		}
26
27	13	public function getReflection(): ReflectionParameter
28		{
29	13	return $this->parameter;
30		}
31
32	70	public function isVariadic(): bool
33		{
34	70	return $this->parameter->isVariadic();
35		}
36
37	27	public function isOptional(): bool
38		{
39	27	return $this->parameter->isOptional();
40		}
41
42	20	public function hasValue(): bool
43		{
44	20	return $this->parameter->isDefaultValueAvailable();
45		}
46
47	51	public function resolve(ContainerInterface $container): mixed
48		{
49	51	$type = $this->parameter->getType();
50
51	51	if ($type === null \|\| $this->isVariadic()) {
52	2	return $this->resolveVariadicOrBuiltinOrNonTyped();
53		}
54
55	49	if ($this->isUnionType()) {
56	8	return $this->resolveUnionType($container);
57		}
58
59		/** @var ReflectionNamedType\|null $type */
60	41	$type = $this->parameter->getType();
61	41	$isBuiltin = $type !== null && $type->isBuiltin();
62
63	41	if (!$isBuiltin) {
64		/** @var ReflectionNamedType $type */
65	21	$typeName = $type->getName();
66	21	if ($typeName === 'self') {
67		// If type name is "self", it means that called class and
68		// $parameter->getDeclaringClass() returned instance of `ReflectionClass`.
69		/** @psalm-suppress PossiblyNullReference */
70	1	$typeName = $this->parameter->getDeclaringClass()->getName();
71		}
72
73		try {
74		/** @var mixed */
75	21	$result = $container->get($typeName);
76	13	} catch (Throwable $t) {
77		if (
78	13	$this->parameter->isOptional()
79		&& (
80		$t instanceof CircularReferenceException
81	13	\|\| !$container->has($typeName)
82		)
83		) {
84	6	return $this->parameter->getDefaultValue();
85		}
86	7	throw $t;
87		}
88
89	8	if (!$result instanceof $typeName) {
90	1	$actualType = get_debug_type($result);
91	1	throw new InvalidConfigException(
92	1	"Container returned incorrect type \"$actualType\" for service \"{$type->getName()}\"."
93		);
94		}
95	7	return $result;
96		}
97
98	22	return $this->resolveVariadicOrBuiltinOrNonTyped();
99		}
100
101		/**
102		* @throws NotInstantiableException
103		*
104		* @return mixed
105		*/
106	25	private function resolveVariadicOrBuiltinOrNonTyped()
107		{
108	25	if ($this->parameter->isDefaultValueAvailable()) {
109	22	return $this->parameter->getDefaultValue();
110		}
111
112	3	if ($this->isOptional()) {
113		throw new NotInstantiableException(
114		sprintf(
115		'Can not determine default value of parameter "%s" when instantiating "%s" ' .
116		'because it is PHP internal. Please specify argument explicitly.',
117		$this->parameter->getName(),
118		$this->getCallable(),
119		)
120		);
121		}
122
123	3	$type = $this->getType();
124
125	3	if ($type === null) {
126	1	throw new NotInstantiableException(
127	1	sprintf(
128		'Can not determine value of the "%s" parameter without type when instantiating "%s". ' .
129	1	'Please specify argument explicitly.',
130	1	$this->parameter->getName(),
131	1	$this->getCallable(),
132		)
133		);
134		}
135
136	2	throw new NotInstantiableException(
137	2	sprintf(
138		'Can not determine value of the "%s" parameter of type "%s" when instantiating "%s". ' .
139	2	'Please specify argument explicitly.',
140	2	$this->parameter->getName(),
141		$type,
142	2	$this->getCallable(),
143		)
144		);
145		}
146
147		/**
148		* Resolve union type string provided as a class name.
149		*
150		* @throws InvalidConfigException If an object of incorrect type was created.
151		* @throws Throwable
152		*
153		* @return mixed\|null Ready to use object or null if definition can
154		* not be resolved and is marked as optional.
155		*/
156	8	private function resolveUnionType(ContainerInterface $container)
157		{
158		/**
159		* @var ReflectionUnionType $parameterType
160		*/
161	8	$parameterType = $this->parameter->getType();
162
163		/**
164		* @var ReflectionNamedType[] $types
165		*/
166	8	$types = $parameterType->getTypes();
167	8	$class = implode('\|', $types);
168
169	8	foreach ($types as $type) {
170	8	if (!$type->isBuiltin()) {
171	7	$typeName = $type->getName();
172		/**
173		* @psalm-suppress TypeDoesNotContainType
174		*
175		* @link https://github.com/vimeo/psalm/issues/6756
176		*/
177	7	if ($typeName === 'self') {
178		// If type name is "self", it means that called class and
179		// $parameter->getDeclaringClass() returned instance of `ReflectionClass`.
180		/** @psalm-suppress PossiblyNullReference */
181	1	$typeName = $this->parameter->getDeclaringClass()->getName();
182		}
183
184		try {
185		/** @var mixed */
186	7	$result = $container->get($typeName);
187	3	$resolved = true;
188	6	} catch (Throwable $t) {
189	6	$error = $t;
190	6	$resolved = false;
191		}
192
193	7	if ($resolved) {
194		/** @var mixed $result Exist, because $resolved is true */
195	3	if (!$result instanceof $typeName) {
196	1	$actualType = get_debug_type($result);
197	1	throw new InvalidConfigException(
198	1	"Container returned incorrect type \"$actualType\" for service \"$class\"."
199		);
200		}
201	2	return $result;
202		}
203
204		/** @var Throwable $error Exist, because $resolved is false */
205		if (
206		!$error instanceof CircularReferenceException
		0 ignored issues – show Comprehensibility Best Practice introduced 2022-05-17 14:55 UTC by Report Bug Copy Issue Report The variable `$error` does not seem to be defined for all execution paths leading up to this point. Loading history...
207	6	&& $container->has($typeName)
208		) {
209	1	throw $error;
210		}
211		}
212		}
213
214	4	if ($this->parameter->isOptional()) {
215	1	return null;
216		}
217
218	3	if (!isset($error)) {
219	1	return $this->resolveVariadicOrBuiltinOrNonTyped();
220		}
221
222	2	throw $error;
223		}
224
225	49	private function isUnionType(): bool
226		{
227	49	return $this->parameter->getType() instanceof ReflectionUnionType;
228		}
229
230	3	private function getType(): ?string
231		{
232	3	$type = $this->parameter->getType();
233
234	3	if ($type instanceof ReflectionUnionType) {
235	1	$namedTypes = $type->getTypes();
236	1	$names = array_map(
237	1	static fn (ReflectionNamedType $t) => $t->getName(),
238		$namedTypes
239		);
240	1	return implode('\|', $names);
241		}
242
243	2	if ($type instanceof ReflectionNamedType) {
244	1	return $type->getName();
245		}
246
247	1	return null;
248		}
249
250	3	private function getCallable(): string
251		{
252	3	$callable = [];
253
254	3	$class = $this->parameter->getDeclaringClass();
255	3	if ($class !== null) {
256	3	$callable[] = $class->getName();
257		}
258	3	$callable[] = $this->parameter
259	3	->getDeclaringFunction()
260	3	->getName() .
261		'()';
262
263	3	return implode('::', $callable);
264		}
265		}
266

yiisoft / definitions

Pull Request — master (#41)

ParameterDefinition::getValueType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like