OptionsMethodRequest::__invoke() - Code Metrics - bearsunday/BEAR.Resource - Measure and Improve Code Quality continuously with Scrutinizer

OptionsMethodRequest::__invoke() A
last analyzed 2025-07-02 15:51 UTC

↳ Parent: OptionsMethodRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	3
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace BEAR\Resource;

use ReflectionException;
use ReflectionMethod;
use ReflectionNamedType;
use ReflectionParameter;

use function assert;
use function is_array;
use function is_string;
use function method_exists;

/**
 * @psalm-import-type OptionsResponse from Types
 * @psalm-import-type InsMap from Types
 */
final class OptionsMethodRequest
{
    /**
     * Parameter #2 $paramMetas of method BEAR\Resource\OptionsMethodRequest::ignoreAnnotatedPrameter() expects array('parameters' => array<string, array('type' =>
     *
     * @param array<array-key, array{type: string, description?: string}> $paramDoc

     * @param InsMap                                                      $ins
     *
     * @return OptionsResponse
     */
    public function __invoke(ReflectionMethod $method, array $paramDoc, array $ins): array
    {
        return $this->getParamMetas($method->getParameters(), $paramDoc, $ins);

    }

    /**
     * @param array<string, array{type?: string, description?: string}> $paramDoc
     *
     * @psalm-suppress RedundantCondition for BC
     */
    private function getParameterType(ReflectionParameter $parameter, array $paramDoc, string $name): string|null
    {
        $hasType = method_exists($parameter, 'getType') && $parameter->getType();
        if ($hasType) {
            return $this->getType($parameter);
        }

        return $paramDoc[$name]['type'] ?? null;
    }

    /**
     * @param array<ReflectionParameter>                               $parameters
     * @param array<string, array{type: string, description?: string}> $paramDoc
     * @param InsMap                                                   $ins
filter:
    dependency_paths: ["lib/*"]
     *
     * @return OptionsResponse
filter:
    dependency_paths: ["lib/*"]
     */
    private function getParamMetas(array $parameters, array $paramDoc, array $ins): array
    {
        foreach ($parameters as $parameter) {
            $name = (string) $parameter->name;
            if (isset($ins[$name])) {
                $paramDoc[$name]['in'] = $ins[$parameter->name];
            }

            if (! isset($paramDoc[$parameter->name])) {
                $paramDoc[$name] = [];
            }

            $paramDoc = $this->paramType($paramDoc, $parameter);
            $paramDoc = $this->paramDefault($paramDoc, $parameter);
        }

        $required = $this->getRequired($parameters);

        return $this->setParamMetas($paramDoc, $required);

    }

    /**
     * @param array<ReflectionParameter> $parameters
     *
     * @return string[]
     * @psalm-return list<string>
     */
    private function getRequired(array $parameters): array
    {
        $required = [];
        foreach ($parameters as $parameter) {
            if ($parameter->isOptional()) {
                continue;
            }

            $required[] = $parameter->name;
        }

        return $required;
    }

    /**
     * @param array<string, array{type?: string, description?: string}> $paramDoc
     *
     * @return array<string, array{type?: string, description?: string, default?: string}>
     *
     * @throws ReflectionException
     */
    private function paramDefault(array $paramDoc, ReflectionParameter $parameter): array
    {
        $hasDefault = $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null;
        if ($hasDefault) {
            $default = $parameter->getDefaultValue();
            $paramDoc[(string) $parameter->name]['default'] = is_array($default) ? '[]' : (string) $parameter->getDefaultValue(); // @phpstan-ignore-lines
        }

        return $paramDoc;
    }

    /**
     * @param array<string, array{type?: string, description?: string, default?: string, in?: string}> $paramDoc
     *
     * @return array<string, array{type?: string, description?: string, default?: string, in?: string}>
     */
    private function paramType(array $paramDoc, ReflectionParameter $parameter): array
    {
        $type = $this->getParameterType($parameter, $paramDoc, $parameter->name);
        if (is_string($type)) {
            $paramDoc[(string) $parameter->name]['type'] = $type; // override type parameter by reflection over phpdoc param type
        }

        return $paramDoc;
    }

    private function getType(ReflectionParameter $parameter): string
    {
        $namedType = $parameter->getType();
        assert($namedType instanceof ReflectionNamedType);
        $type = $namedType->getName();
        if ($type === 'int') {
            $type = 'integer';
        }

        return $type;
    }

    /**
     * @param array<string, array{type?: string}> $paramDoc
     * @param list<string>                        $required
filter:
    dependency_paths: ["lib/*"]
     *
     * @return OptionsResponse
     */
    private function setParamMetas(array $paramDoc, array $required): array
    {
        $paramMetas = [];
        if ((bool) $paramDoc) {
            $paramMetas['parameters'] = $paramDoc;
        }

        if ((bool) $required) {
            $paramMetas['required'] = $required;
        }

        return $paramMetas;

    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace BEAR\Resource;
6
7			use ReflectionException;
8			use ReflectionMethod;
9			use ReflectionNamedType;
10			use ReflectionParameter;
11
12			use function assert;
13			use function is_array;
14			use function is_string;
15			use function method_exists;
16
17			/**
18			* @psalm-import-type OptionsResponse from Types
19			* @psalm-import-type InsMap from Types
20			*/
21			final class OptionsMethodRequest
22			{
23			/**
24			* Parameter #2 $paramMetas of method BEAR\Resource\OptionsMethodRequest::ignoreAnnotatedPrameter() expects array('parameters' => array<string, array('type' =>
25			*
26			* @param array<array-key, array{type: string, description?: string}> $paramDoc
			0 ignored issues – show Documentation Bug introduced 2025-07-01 16:17 UTC by Report Bug Copy Issue Report The doc comment `array<array-key, array{t... description?: string}>` at position `2` could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, array{type: string, description?: string}>. Loading history...
27			* @param InsMap $ins
28			*
29			* @return OptionsResponse
30			*/
31			public function __invoke(ReflectionMethod $method, array $paramDoc, array $ins): array
32			{
33			return $this->getParamMetas($method->getParameters(), $paramDoc, $ins);
			0 ignored issues – show Bug Best Practice introduced 2025-07-02 01:08 UTC by Report Bug Copy Issue Report The expression `return $this->getParamMe...ers(), $paramDoc, $ins)` returns the type `array` which is incompatible with the documented return type `BEAR\Resource\OptionsResponse`. Loading history...
34			}
35
36			/**
37			* @param array<string, array{type?: string, description?: string}> $paramDoc
38			*
39			* @psalm-suppress RedundantCondition for BC
40			*/
41			private function getParameterType(ReflectionParameter $parameter, array $paramDoc, string $name): string\|null
42			{
43			$hasType = method_exists($parameter, 'getType') && $parameter->getType();
44			if ($hasType) {
45			return $this->getType($parameter);
46			}
47
48			return $paramDoc[$name]['type'] ?? null;
49			}
50
51			/**
52			* @param array<ReflectionParameter> $parameters
53			* @param array<string, array{type: string, description?: string}> $paramDoc
54			* @param InsMap $ins
			0 ignored issues – show Bug introduced 2025-07-02 01:08 UTC by Report Bug Copy Issue Report The type `BEAR\Resource\InsMap` 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...
55			*
56			* @return OptionsResponse
			0 ignored issues – show Bug introduced 2025-07-02 01:08 UTC by Report Bug Copy Issue Report The type `BEAR\Resource\OptionsResponse` 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...
57			*/
58			private function getParamMetas(array $parameters, array $paramDoc, array $ins): array
59			{
60			foreach ($parameters as $parameter) {
61			$name = (string) $parameter->name;
62			if (isset($ins[$name])) {
63			$paramDoc[$name]['in'] = $ins[$parameter->name];
64			}
65
66			if (! isset($paramDoc[$parameter->name])) {
67			$paramDoc[$name] = [];
68			}
69
70			$paramDoc = $this->paramType($paramDoc, $parameter);
71			$paramDoc = $this->paramDefault($paramDoc, $parameter);
72			}
73
74			$required = $this->getRequired($parameters);
75
76			return $this->setParamMetas($paramDoc, $required);
			0 ignored issues – show Bug Best Practice introduced 2025-07-02 01:08 UTC by Report Bug Copy Issue Report The expression `return $this->setParamMetas($paramDoc, $required)` returns the type `array` which is incompatible with the documented return type `BEAR\Resource\OptionsResponse`. Loading history...
77			}
78
79			/**
80			* @param array<ReflectionParameter> $parameters
81			*
82			* @return string[]
83			* @psalm-return list<string>
84			*/
85			private function getRequired(array $parameters): array
86			{
87			$required = [];
88			foreach ($parameters as $parameter) {
89			if ($parameter->isOptional()) {
90			continue;
91			}
92
93			$required[] = $parameter->name;
94			}
95
96			return $required;
97			}
98
99			/**
100			* @param array<string, array{type?: string, description?: string}> $paramDoc
101			*
102			* @return array<string, array{type?: string, description?: string, default?: string}>
103			*
104			* @throws ReflectionException
105			*/
106			private function paramDefault(array $paramDoc, ReflectionParameter $parameter): array
107			{
108			$hasDefault = $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null;
109			if ($hasDefault) {
110			$default = $parameter->getDefaultValue();
111			$paramDoc[(string) $parameter->name]['default'] = is_array($default) ? '[]' : (string) $parameter->getDefaultValue(); // @phpstan-ignore-lines
112			}
113
114			return $paramDoc;
115			}
116
117			/**
118			* @param array<string, array{type?: string, description?: string, default?: string, in?: string}> $paramDoc
119			*
120			* @return array<string, array{type?: string, description?: string, default?: string, in?: string}>
121			*/
122			private function paramType(array $paramDoc, ReflectionParameter $parameter): array
123			{
124			$type = $this->getParameterType($parameter, $paramDoc, $parameter->name);
125			if (is_string($type)) {
126			$paramDoc[(string) $parameter->name]['type'] = $type; // override type parameter by reflection over phpdoc param type
127			}
128
129			return $paramDoc;
130			}
131
132			private function getType(ReflectionParameter $parameter): string
133			{
134			$namedType = $parameter->getType();
135			assert($namedType instanceof ReflectionNamedType);
136			$type = $namedType->getName();
137			if ($type === 'int') {
138			$type = 'integer';
139			}
140
141			return $type;
142			}
143
144			/**
145			* @param array<string, array{type?: string}> $paramDoc
146			* @param list<string> $required
			0 ignored issues – show Bug introduced 2021-10-31 14:08 UTC by Report Bug Copy Issue Report The type `BEAR\Resource\list` 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...
147			*
148			* @return OptionsResponse
149			*/
150			private function setParamMetas(array $paramDoc, array $required): array
151			{
152			$paramMetas = [];
153			if ((bool) $paramDoc) {
154			$paramMetas['parameters'] = $paramDoc;
155			}
156
157			if ((bool) $required) {
158			$paramMetas['required'] = $required;
159			}
160
161			return $paramMetas;
			0 ignored issues – show Bug Best Practice introduced 2025-07-02 01:08 UTC by Report Bug Copy Issue Report The expression `return $paramMetas` returns the type `array` which is incompatible with the documented return type `BEAR\Resource\OptionsResponse`. Loading history...
162			}
163			}
164

bearsunday / BEAR.Resource

OptionsMethodRequest::__invoke() A last analyzed 2025-07-02 15:51 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OptionsMethodRequest::__invoke() A
last analyzed 2025-07-02 15:51 UTC