Yiisoft\Router\Group

Complexity

Total Complexity

28

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Test Coverage

Coverage

91.84%

Importance

Changes	7
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	assertMiddlewares()	0	14	5
A	assertHosts()	0	5	3
A	middleware()	0	12	2
A	withCors()	0	6	1
A	host()	0	3	1
A	routes()	0	10	2
A	getBuiltMiddlewares()	0	16	4
A	create()	0	15	1
A	getData()	0	12	1
A	disableMiddleware()	0	9	1
A	prependMiddleware()	0	10	1
A	hosts()	0	13	4
A	__construct()	0	13	1
A	namePrefix()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use Attribute;
use InvalidArgumentException;
use RuntimeException;

use function in_array;

#[Attribute(Attribute::TARGET_CLASS)]
final class Group
{
    /**
     * @var Group[]|Route[]
     */
    private array $routes = [];
    private bool $routesAdded = false;
    private bool $middlewareAdded = false;
    private array $builtMiddlewares = [];
    /**
     * @var array|callable|string|null Middleware definition for CORS requests.
     */
    private $corsMiddleware;
    /**
     * @var string[]
     */
    private array $hosts = [];
    /**
     * @var array[]|callable[]|string[]
     */
    private array $middlewares = [];

    /**
     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     */
    public function __construct(
        private ?string $prefix = null,
        array $middlewares = [],
        array $hosts = [],
        private ?string $namePrefix = null,
        private array $disabledMiddlewares = [],
        array|callable|string|null $corsMiddleware = null
    ) {
        $this->assertMiddlewares($middlewares);
        $this->assertHosts($hosts);
        $this->middlewares = $middlewares;
        $this->hosts = $hosts;
        $this->corsMiddleware = $corsMiddleware;
    }

    /**
     * Create a new group instance.
     *
     * @param string|null $prefix URL prefix to prepend to all routes of the group.
     */
    public static function create(
        ?string $prefix = null,
        array $middlewares = [],
        array $hosts = [],
        ?string $namePrefix = null,
        array $disabledMiddlewares = [],
        array|callable|string|null $corsMiddleware = null
    ): self {
        return new self(
            prefix: $prefix,
            middlewares: $middlewares,
            hosts: $hosts,
            namePrefix: $namePrefix,
            disabledMiddlewares: $disabledMiddlewares,
            corsMiddleware: $corsMiddleware
        );
    }

    public function routes(self|Route ...$routes): self
    {
        if ($this->middlewareAdded) {
            throw new RuntimeException('routes() can not be used after prependMiddleware().');
        }
        $new = clone $this;
        $new->routes = $routes;
        $new->routesAdded = true;

        return $new;
    }

    /**
     * Adds a middleware definition that handles CORS requests.
     * If set, routes for {@see Method::OPTIONS} request will be added automatically.
     *
     * @param array|callable|string|null $middlewareDefinition Middleware definition for CORS requests.
     */
    public function withCors(array|callable|string|null $middlewareDefinition): self
    {
        $group = clone $this;
        $group->corsMiddleware = $middlewareDefinition;

        return $group;
    }

    /**
     * Appends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed first.
     */
    public function middleware(array|callable|string ...$middlewareDefinition): self
    {
        if ($this->routesAdded) {
            throw new RuntimeException('middleware() can not be used after routes().');
        }
        $new = clone $this;
        array_push(
            $new->middlewares,
            ...array_values($middlewareDefinition)
        );
        $new->builtMiddlewares = [];
        return $new;
    }

    /**
     * Prepends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed last.
     */
    public function prependMiddleware(array|callable|string ...$middlewareDefinition): self
    {
        $new = clone $this;
        array_unshift(
            $new->middlewares,
            ...array_values($middlewareDefinition)
        );
        $new->middlewareAdded = true;
        $new->builtMiddlewares = [];
        return $new;
    }

    public function namePrefix(string $namePrefix): self
    {
        $new = clone $this;
        $new->namePrefix = $namePrefix;
        return $new;
    }

    public function host(string $host): self
    {
        return $this->hosts($host);
    }

    public function hosts(string ...$hosts): self
    {
        $new = clone $this;

        foreach ($hosts as $host) {
            $host = rtrim($host, '/');

            if ($host !== '' && !in_array($host, $new->hosts, true)) {
                $new->hosts[] = $host;
            }
        }

        return $new;
    }

    /**
     * Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     */
    public function disableMiddleware(mixed ...$middlewareDefinition): self
    {
        $new = clone $this;
        array_push(
            $new->disabledMiddlewares,
            ...array_values($middlewareDefinition),
        );
        $new->builtMiddlewares = [];
        return $new;
    }

    /**
     * @psalm-template T as string
     *
     * @psalm-param T $key
     *
     * @psalm-return (
     *   T is ('prefix'|'namePrefix'|'host') ? string|null :
     *   (T is 'routes' ? Group[]|Route[] :
     *     (T is 'hosts' ? array<array-key, string> :
     *       (T is 'hasCorsMiddleware' ? bool :
     *         (T is 'middlewares' ? list<array|callable|string> :
     *           (T is 'corsMiddleware' ? array|callable|string|null : mixed)
     *         )
     *       )
     *     )
     *   )
     * )
     */
    public function getData(string $key): mixed
    {
        return match ($key) {
            'prefix' => $this->prefix,
            'namePrefix' => $this->namePrefix,
            'host' => $this->hosts[0] ?? null,
            'hosts' => $this->hosts,
            'corsMiddleware' => $this->corsMiddleware,
            'routes' => $this->routes,
            'hasCorsMiddleware' => $this->corsMiddleware !== null,
            'middlewares' => $this->getBuiltMiddlewares(),
            default => throw new InvalidArgumentException('Unknown data key: ' . $key),
        };
    }

    private function getBuiltMiddlewares(): array
    {
        if (!empty($this->builtMiddlewares)) {
            return $this->builtMiddlewares;
        }

        $builtMiddlewares = $this->middlewares;

        /** @var mixed $definition */
        foreach ($builtMiddlewares as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewares, true)) {
                unset($builtMiddlewares[$index]);
            }
        }

        return $this->builtMiddlewares = array_values($builtMiddlewares);
    }

    /**
     * @psalm-assert array<string> $hosts
     */
    private function assertHosts(array $hosts): void
    {
        foreach ($hosts as $host) {
            if (!is_string($host)) {
                throw new \InvalidArgumentException('Invalid hosts provided, list of string expected.');
            }
        }
    }

    /**
     * @psalm-assert array<array|callable|string> $middlewares
     */
    private function assertMiddlewares(array $middlewares): void
    {
        /** @var mixed $middleware */
        foreach ($middlewares as $middleware) {
            if (is_string($middleware)) {
                continue;
            }

            if (is_callable($middleware) || is_array($middleware)) {
                continue;
            }

            throw new \InvalidArgumentException(
                'Invalid middlewares provided, list of string or array or callable expected.'
            );
        }
    }
}