Spiral\Bootloader\Http\RoutesBootloader

Complexity

Total Complexity

9

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	4	2
A	configureRouteGroups()	0	2	1
A	registerMiddlewareGroups()	0	7	2
A	defineRoutes()	0	2	1
A	registerMiddlewareForRouteGroups()	0	4	2
A	boot()	0	9	1

<?php

declare(strict_types=1);

namespace Spiral\Bootloader\Http;

use Psr\Http\Server\MiddlewareInterface;
use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Core\BinderInterface;
use Spiral\Http\Pipeline;
use Spiral\Router\GroupRegistry;
use Spiral\Router\Loader\Configurator\RoutingConfigurator;
use Spiral\Router\PipelineFactory;

abstract class RoutesBootloader extends Bootloader
{
    public function init(HttpBootloader $http): void
    {
        foreach ($this->globalMiddleware() as $middleware) {
            $http->addMiddleware($middleware);
        }
    }

    public function boot(RoutingConfigurator $routes, BinderInterface $binder, GroupRegistry $groups): void
    {
        $middlewareGroups = $this->middlewareGroups();

        $this->registerMiddlewareGroups($binder, $middlewareGroups);
        $this->registerMiddlewareForRouteGroups($groups, \array_keys($middlewareGroups));

        $this->configureRouteGroups($groups);
        $this->defineRoutes($routes);
    }

    /**
     * Override this method to configure application routes
     */
    protected function defineRoutes(RoutingConfigurator $routes): void
    {
    }

    /**
     * Override this method to configure route groups
     */
    protected function configureRouteGroups(GroupRegistry $groups): void

The parameter $groups is not used and could be removed.

    {
    }

    /**
     * @return array<MiddlewareInterface|class-string<MiddlewareInterface>>

The doc comment array<MiddlewareInterface|class-string<MiddlewareInterface>> at position 4 could not be parsed: Unknown type name 'class-string' at position 4 in array<MiddlewareInterface|class-string<MiddlewareInterface>>.

     */
    abstract protected function globalMiddleware(): array;

    /**
     * @return array<string,array<MiddlewareInterface|class-string<MiddlewareInterface>>>

The doc comment array<string,array<MiddlewareInterface|class-string<MiddlewareInterface>>> at position 8 could not be parsed: Unknown type name 'class-string' at position 8 in array<string,array<MiddlewareInterface|class-string<MiddlewareInterface>>>.

     */
    abstract protected function middlewareGroups(): array;

    private function registerMiddlewareGroups(BinderInterface $binder, array $groups): void
    {
        foreach ($groups as $group => $middleware) {
            $binder->bind(
                'middleware:' . $group,
                static function (PipelineFactory $factory) use ($middleware): Pipeline {
                    return $factory->createWithMiddleware($middleware);
                }
            );
        }
    }

    private function registerMiddlewareForRouteGroups(GroupRegistry $registry, array $groups): void
    {
        foreach ($groups as $group) {
            $registry->getGroup($group)->addMiddleware('middleware:' . $group);
        }
    }
}