Yiisoft\Router\Route

Complexity

Total Complexity

45

Size/Duplication

Total Lines	354
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	17
Bugs	5	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	patch()	0	3	1
A	getData()	0	14	1
A	put()	0	3	1
A	getBuiltMiddlewares()	0	17	4
A	assertMiddlewares()	0	14	5
A	hosts()	0	14	4
A	name()	0	5	1
A	defaults()	0	5	1
A	override()	0	5	1
A	head()	0	3	1
A	methods()	0	5	1
A	action()	0	7	1
A	pattern()	0	5	1
A	delete()	0	3	1
A	assertListOfStrings()	0	5	3
A	get()	0	3	1
A	disableMiddleware()	0	9	1
A	post()	0	3	1
A	options()	0	3	1
A	__toString()	0	21	5
A	middleware()	0	12	2
A	host()	0	3	1
A	prependMiddleware()	0	12	2
A	__debugInfo()	0	13	1
A	__construct()	0	24	3

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use InvalidArgumentException;
use RuntimeException;
use Stringable;
use Yiisoft\Http\Method;

use function in_array;

/**
 * Route defines a mapping from URL to callback / name and vice versa.
 */
final class Route implements Stringable
{
    private bool $actionAdded = false;
    /**
     * @var array[]|callable[]|string[]
     */
    private array $builtMiddlewareDefinitions = [];
    /**
     * @var array[]|callable[]|string[]
     */
    private array $middlewareDefinitions = [];
    /**
     * @var string[]
     */
    private array $methods;
    /**
     * @var string[]
     */
    private array $hosts = [];
    /**
     * @var array<string,scalar|Stringable|null>
     */
    private array $defaults = [];

    /**
     * @param array|callable|string|null $action Action handler. It is a primary middleware definition that
     * should be invoked last for a matched route.
     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
     * @param array $disabledMiddlewareDefinitions 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(
        array $methods,
        private string $pattern,
        private ?string $name = null,
        array|callable|string $action = null,
        array $middlewareDefinitions = [],
        array $defaults = [],
        array $hosts = [],
        private bool $override = false,
        private array $disabledMiddlewareDefinitions = [],
    ) {
        if (empty($methods)) {
            throw new InvalidArgumentException('$methods cannot be empty.');
        }
        $this->assertListOfStrings($methods, 'methods');
        $this->assertMiddlewares($middlewareDefinitions);
        $this->assertListOfStrings($hosts, 'hosts');
        $this->methods = $methods;
        $this->middlewareDefinitions = $middlewareDefinitions;
        $this->hosts = $hosts;
        $this->defaults = array_map('\strval', $defaults);
        if (!empty($action)) {
            $this->middlewareDefinitions[] = $action;
            $this->actionAdded = true;
        }
    }

    public static function get(string $pattern): self
    {
        return self::methods([Method::GET], $pattern);
    }

    public static function post(string $pattern): self
    {
        return self::methods([Method::POST], $pattern);
    }

    public static function put(string $pattern): self
    {
        return self::methods([Method::PUT], $pattern);
    }

    public static function delete(string $pattern): self
    {
        return self::methods([Method::DELETE], $pattern);
    }

    public static function patch(string $pattern): self
    {
        return self::methods([Method::PATCH], $pattern);
    }

    public static function head(string $pattern): self
    {
        return self::methods([Method::HEAD], $pattern);
    }

    public static function options(string $pattern): self
    {
        return self::methods([Method::OPTIONS], $pattern);
    }

    /**
     * @param string[] $methods
     */
    public static function methods(array $methods, string $pattern): self
    {
        return new self(
            methods: $methods,
            pattern: $pattern
        );
    }

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

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

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

    public function hosts(string ...$hosts): self
    {
        $route = clone $this;
        $route->hosts = [];

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

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

        return $route;
    }

    /**
     * Marks route as override. When added it will replace existing route with the same name.
     */
    public function override(): self
    {
        $route = clone $this;
        $route->override = true;
        return $route;
    }

    /**
     * Parameter default values indexed by parameter names.
     *
     * @psalm-param array<string,null|Stringable|scalar> $defaults
     */
    public function defaults(array $defaults): self
    {
        $route = clone $this;
        $route->defaults = array_map('\strval', $defaults);
        return $route;
    }

    /**
     * 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->actionAdded) {
            throw new RuntimeException('middleware() can not be used after action().');
        }
        $route = clone $this;
        array_push(
            $route->middlewareDefinitions,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewareDefinitions = [];
        return $route;
    }

    /**
     * Prepends a handler middleware definition that should be invoked for a matched route.
     * Last added handler will be executed first.
     */
    public function prependMiddleware(array|callable|string ...$middlewareDefinition): self
    {
        if (!$this->actionAdded) {
            throw new RuntimeException('prependMiddleware() can not be used before action().');
        }
        $route = clone $this;
        array_unshift(
            $route->middlewareDefinitions,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewareDefinitions = [];
        return $route;
    }

    /**
     * Appends action handler. It is a primary middleware definition that should be invoked last for a matched route.
     */
    public function action(array|callable|string $middlewareDefinition): self
    {
        $route = clone $this;
        $route->middlewareDefinitions[] = $middlewareDefinition;
        $route->actionAdded = true;
        $route->builtMiddlewareDefinitions = [];
        return $route;
    }

    /**
     * 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
    {
        $route = clone $this;
        array_push(
            $route->disabledMiddlewareDefinitions,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewareDefinitions = [];
        return $route;
    }

    /**
     * @psalm-template T as string
     *
     * @psalm-param T $key
     *
     * @psalm-return (
     *   T is ('name'|'pattern') ? string :
     *       (T is 'host' ? string|null :
     *           (T is 'hosts' ? array<array-key, string> :
     *               (T is 'methods' ? array<array-key,string> :
     *                   (T is 'defaults' ? array<string,string> :
     *                       (T is ('override'|'hasMiddlewares') ? bool :
     *                           (T is 'builtMiddlewareDefinitions' ? array<array-key,array|callable|string> : mixed)
     *                       )
     *                   )
     *               )
     *           )
     *       )
     *    )
     */
    public function getData(string $key): mixed
    {
        return match ($key) {
            'name' => $this->name ??
                (implode(', ', $this->methods) . ' ' . implode('|', $this->hosts) . $this->pattern),
            'pattern' => $this->pattern,
            'host' => $this->hosts[0] ?? null,
            'hosts' => $this->hosts,
            'methods' => $this->methods,
            'defaults' => $this->defaults,
            'override' => $this->override,
            'hasMiddlewares' => !empty($this->middlewareDefinitions),
            'builtMiddlewareDefinitions' => $this->getBuiltMiddlewares(),
            default => throw new InvalidArgumentException('Unknown data key: ' . $key),
        };
    }

    public function __toString(): string
    {
        $result = $this->name === null
            ? ''
            : '[' . $this->name . '] ';

        if ($this->methods !== []) {
            $result .= implode(',', $this->methods) . ' ';
        }

        if ($this->hosts) {

The expression $this->hosts of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $quoted = array_map(static fn ($host) => preg_quote($host, '/'), $this->hosts);

            if (!preg_match('/' . implode('|', $quoted) . '/', $this->pattern)) {
                $result .= implode('|', $this->hosts);
            }
        }

        $result .= $this->pattern;

        return $result;
    }

    public function __debugInfo()
    {
        return [
            'name' => $this->name,
            'methods' => $this->methods,
            'pattern' => $this->pattern,
            'hosts' => $this->hosts,
            'defaults' => $this->defaults,
            'override' => $this->override,
            'actionAdded' => $this->actionAdded,
            'middlewareDefinitions' => $this->middlewareDefinitions,
            'builtMiddlewareDefinitions' => $this->builtMiddlewareDefinitions,
            'disabledMiddlewareDefinitions' => $this->disabledMiddlewareDefinitions,
        ];
    }

    /**
     * @return array[]|callable[]|string[]
     */
    private function getBuiltMiddlewares(): array
    {
        // Don't build middlewareDefinitions if we did it earlier.
        // This improves performance in event-loop applications.
        if (!empty($this->builtMiddlewareDefinitions)) {
            return $this->builtMiddlewareDefinitions;
        }

        $builtMiddlewareDefinitions = $this->middlewareDefinitions;

        foreach ($builtMiddlewareDefinitions as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
                unset($builtMiddlewareDefinitions[$index]);
            }
        }

        return $this->builtMiddlewareDefinitions = $builtMiddlewareDefinitions;
    }

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

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

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

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