RouteAttributesRegistrar::register() - Code Metrics - Inspection of "Add attributes support & improve `MatchingResult`" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#196)

by Alexander

created 2023-06-15 17:55 UTC

RouteAttributesRegistrar::register() A

↳ Parent: RouteAttributesRegistrar

Complexity

Conditions	4
Paths	4

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	13
nc	4
nop	0
dl	0
loc	19
ccs	13
cts	13
cp	1
crap	4
rs	9.8333
c	1
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

/**
 * Provides an implementation of {@see RouteAttributesRegistrarInterface} using {@see get_declared_classes()} function.
 */
final class RouteAttributesRegistrar implements RouteAttributesRegistrarInterface
{
    public function __construct(private RouteCollectorInterface $routeCollector)
    {
    }

    /**
     * @inheritDoc
     */
    public function register(): void
    {
        //TODO: caching?
        $classes = get_declared_classes();
        foreach ($classes as $class) {
            $reflectionClass = new \ReflectionClass($class);
            if (!$reflectionClass->isUserDefined()) {
                continue;
            }
            $routes = $this->lookupRoutes($reflectionClass);
            $groupAttributes = $reflectionClass->getAttributes(Group::class, \ReflectionAttribute::IS_INSTANCEOF);

            if (!empty($groupAttributes)) {
                [$groupAttribute] = $groupAttributes;
                /** @var Group $group */
                $group = $groupAttribute->newInstance();
                $this->routeCollector->addRoute($group->routes(...iterator_to_array($routes)));
            } else {
                $this->routeCollector->addRoute(...iterator_to_array($routes));
            }
        }
    }

    /**
     * @return \Generator<Route>
     */
    private function lookupRoutes(\ReflectionClass $reflectionClass): \Generator
    {
        foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflectionMethod) {
            foreach (
                $reflectionMethod->getAttributes(
                    Route::class,
                    \ReflectionAttribute::IS_INSTANCEOF
                ) as $reflectionAttribute
            ) {
                /** @var Route $route */
                $route = $reflectionAttribute->newInstance();

                yield $route->action([$reflectionClass->getName(), $reflectionMethod->getName()]);
            }
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Router;
6
7		/**
8		* Provides an implementation of {@see RouteAttributesRegistrarInterface} using {@see get_declared_classes()} function.
9		*/
10		final class RouteAttributesRegistrar implements RouteAttributesRegistrarInterface
11		{
12	1	public function __construct(private RouteCollectorInterface $routeCollector)
13		{
14	1	}
15
16		/**
17		* @inheritDoc
18		*/
19	1	public function register(): void
20		{
21		//TODO: caching?
22	1	$classes = get_declared_classes();
23	1	foreach ($classes as $class) {
24	1	$reflectionClass = new \ReflectionClass($class);
25	1	if (!$reflectionClass->isUserDefined()) {
26	1	continue;
27		}
28	1	$routes = $this->lookupRoutes($reflectionClass);
29	1	$groupAttributes = $reflectionClass->getAttributes(Group::class, \ReflectionAttribute::IS_INSTANCEOF);
30
31	1	if (!empty($groupAttributes)) {
32	1	[$groupAttribute] = $groupAttributes;
33		/** @var Group $group */
34	1	$group = $groupAttribute->newInstance();
35	1	$this->routeCollector->addRoute($group->routes(...iterator_to_array($routes)));
36		} else {
37	1	$this->routeCollector->addRoute(...iterator_to_array($routes));
38		}
39		}
40		}
41
42		/**
43		* @return \Generator<Route>
44		*/
45	1	private function lookupRoutes(\ReflectionClass $reflectionClass): \Generator
46		{
47	1	foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflectionMethod) {
48		foreach (
49	1	$reflectionMethod->getAttributes(
50	1	Route::class,
51	1	\ReflectionAttribute::IS_INSTANCEOF
52	1	) as $reflectionAttribute
53		) {
54		/** @var Route $route */
55	1	$route = $reflectionAttribute->newInstance();
56
57	1	yield $route->action([$reflectionClass->getName(), $reflectionMethod->getName()]);
58		}
59		}
60		}
61		}
62

yiisoft / router

Pull Request — master (#196)

RouteAttributesRegistrar::register() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like