Yiisoft\Router\Group

Complexity

Total Complexity

25

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	1	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	5	1
A	middleware()	0	11	2
A	withCors()	0	6	1
A	getMiddlewareDefinitions()	0	10	3
A	routes()	0	16	5
A	host()	0	3	1
A	withDispatcher()	0	12	3
A	getData()	0	13	1
A	disableMiddleware()	0	8	1
A	prependMiddleware()	0	9	1
A	hosts()	0	13	4
A	__construct()	0	2	1
A	namePrefix()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use InvalidArgumentException;
use RuntimeException;
use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;

use function in_array;

final class Group
{
    /**
     * @var Group[]|Route[]
     */
    private array $items = [];

    /**
     * @var array[]|callable[]|string[]
     */
    private array $middlewareDefinitions = [];

    /**
     * @var string[]
     */
    private array $hosts = [];
    private ?string $namePrefix = null;
    private bool $routesAdded = false;
    private bool $middlewareAdded = false;
    private array $disabledMiddlewareDefinitions = [];
    /**
     * @var array|callable|string|null Middleware definition for CORS requests.
     */
    private $corsMiddleware = null;

    private function __construct(private ?string $prefix = null, private ?MiddlewareDispatcher $dispatcher = null)
    {
    }

    /**
     * Create a new group instance.
     *
     * @param string|null $prefix URL prefix to prepend to all routes of the group.
     * @param MiddlewareDispatcher|null $dispatcher Middleware dispatcher to use for the group.
     */
    public static function create(
        ?string $prefix = null,
        MiddlewareDispatcher $dispatcher = null
    ): self {
        return new self($prefix, $dispatcher);
    }

    public function routes(self|Route ...$routes): self
    {
        if ($this->middlewareAdded) {
            throw new RuntimeException('routes() can not be used after prependMiddleware().');
        }
        $new = clone $this;
        foreach ($routes as $route) {
            if ($new->dispatcher !== null && !$route->getData('hasDispatcher')) {
                $route = $route->withDispatcher($new->dispatcher);
            }
            $new->items[] = $route;
        }

        $new->routesAdded = true;

        return $new;
    }

    public function withDispatcher(MiddlewareDispatcher $dispatcher): self
    {
        $group = clone $this;
        $group->dispatcher = $dispatcher;
        foreach ($group->items as $index => $item) {
            if (!$item->getData('hasDispatcher')) {
                $item = $item->withDispatcher($dispatcher);
                $group->items[$index] = $item;
            }
        }

        return $group;
    }

    /**
     * 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($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->middlewareDefinitions,
            ...array_values($middlewareDefinition)
        );
        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->middlewareDefinitions,
            ...array_values($middlewareDefinition)
        );
        $new->middlewareAdded = true;
        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->disabledMiddlewareDefinitions,
            ...array_values($middlewareDefinition),
        );
        return $new;
    }

    /**
     * @psalm-template T as string
     * @psalm-param T $key
     * @psalm-return (
     *   T is ('prefix'|'namePrefix'|'host') ? string|null :
     *   (T is 'items' ? Group[]|Route[] :
     *     (T is 'hosts' ? array<array-key, string> :
     *       (T is ('hasCorsMiddleware'|'hasDispatcher') ? bool :
     *         (T is 'middlewareDefinitions' ? 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,
            'items' => $this->items,
            'hasCorsMiddleware' => $this->corsMiddleware !== null,
            'hasDispatcher' => $this->dispatcher !== null,
            'middlewareDefinitions' => $this->getMiddlewareDefinitions(),
            default => throw new InvalidArgumentException('Unknown data key: ' . $key),
        };
    }

    private function getMiddlewareDefinitions(): array
    {
        /** @var mixed $definition */
        foreach ($this->middlewareDefinitions as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
                unset($this->middlewareDefinitions[$index]);
            }
        }

        return array_values($this->middlewareDefinitions);
    }
}