aboutsummaryrefslogtreecommitdiff
path: root/src/Routing/RouteLoader.php
blob: 596340f9e023db91e2530d9ef0e3fedc2603c38a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?php

declare(strict_types=1);

namespace BrettParson\MiniRoute\Routing;

use BrettParson\MiniRoute\Attribute\Middleware;
use BrettParson\MiniRoute\Attribute\RouteAttribute;
use ReflectionAttribute;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;

final class RouteLoader
{
    /**
     * Scan a controller class and compile the routes declared on its public
     * methods.
     *
     * @param class-string $controllerClass
     * @return list<RouteDef>
     */
    public function load(string $controllerClass): array
    {
        if (!class_exists($controllerClass)) {
            throw new RouteRegistrationException("Controller class not found: {$controllerClass}");
        }

        try {
            $reflector = new ReflectionClass($controllerClass);
        } catch (ReflectionException $e) {
            throw new RouteRegistrationException("Unable to reflect controller: {$controllerClass}", 0, $e);
        }

        $classMiddleware = $this->middlewareClasses($reflector->getAttributes(Middleware::class));

        $routes = [];

        foreach ($reflector->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
            foreach ($this->loadMethod($controllerClass, $method, $classMiddleware) as $route) {
                $routes[] = $route;
            }
        }

        return $routes;
    }

    /**
     * @param list<string> $classMiddleware
     * @return list<RouteDef>
     */
    private function loadMethod(string $controllerClass, ReflectionMethod $method, array $classMiddleware): array
    {
        $routeAttributes = $method->getAttributes(RouteAttribute::class, ReflectionAttribute::IS_INSTANCEOF);

        if ($routeAttributes === []) {
            return [];
        }

        $methodMiddleware = $this->middlewareClasses($method->getAttributes(Middleware::class));

        $middleware = array_merge($classMiddleware, $methodMiddleware);

        $routes = [];

        foreach ($routeAttributes as $attribute) {
            /** @var RouteAttribute $route */
            $route = $attribute->newInstance();

            $routes[] = new RouteDef(
                strtoupper($route->method()),
                $route->path(),
                $controllerClass,
                $method->getName(),
                $middleware,
            );
        }

        return $routes;
    }

    /**
     * @param list<ReflectionAttribute> $attributes
     * @return list<string>
     */
    private function middlewareClasses(array $attributes): array
    {
        $classes = [];

        foreach ($attributes as $attribute) {
            /** @var Middleware $middleware */
            $middleware = $attribute->newInstance();
            $classes[] = $middleware->middlewareClass;
        }

        return $classes;
    }
}