Valkyrja\Routing\Models\Route

Complexity

Total Complexity

38

Size/Duplication

Total Lines	421
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

31 Methods

Rating	Name	Duplication	Size	Complexity
A	setRegex()	0	5	1
A	getCode()	0	3	1
A	withPath()	0	7	1
A	setPath()	0	5	1
A	setCode()	0	5	1
A	getMethods()	0	3	1
A	setMethods()	0	10	2
A	getRegex()	0	3	1
A	withName()	0	13	3
A	getTo()	0	3	1
A	getPath()	0	3	1
A	setMiddleware()	0	5	1
A	__setMessages()	0	7	2
A	isRedirect()	0	3	1
A	withMessages()	0	7	1
A	getMessages()	0	3	1
A	getMiddleware()	0	3	1
A	setMessages()	0	5	1
A	setParameters()	0	16	4
A	addParameter()	0	16	1
A	setTo()	0	7	1
A	setRedirect()	0	5	1
A	withMiddleware()	0	7	1
A	withMessage()	0	3	1
A	setDynamic()	0	5	1
A	isDynamic()	0	3	1
A	setSecure()	0	5	1
A	__setParameters()	0	3	1
A	setParameter()	0	7	1
A	isSecure()	0	3	1
A	getParameters()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <melechmizrachi@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Routing\Models;

use InvalidArgumentException;
use Valkyrja\Dispatcher\Models\Dispatch;
use Valkyrja\Http\Constants\RequestMethod;
use Valkyrja\Model\Data\Cast;
use Valkyrja\Routing\Constants\Regex;
use Valkyrja\Routing\Message;
use Valkyrja\Routing\Route as Contract;

use function assert;
use function is_array;

/**
 * Class Route.
 *
 * @author Melech Mizrachi
 */
class Route extends Dispatch implements Contract
{
    /**
     * The path for this route.
     *
     * @var string
     */
    protected string $path = '';

    /**
     * The redirect path for this route.
     *
     * @var string|null
     */
    protected string|null $to;

    /**
     * The redirect status code for this route.
     *
     * @var int|null
     */
    protected int|null $code;

    /**
     * The request methods for this route.
     *
     * @var array
     */
    protected array $methods = [
        RequestMethod::GET,
        RequestMethod::HEAD,
    ];

    /**
     * The regex for dynamic routes.
     *
     * @var string|null
     */
    protected string|null $regex;

    /**
     * The dynamic parameters.
     *
     * @var array<int, Parameter>
     */
    protected array $parameters;

    /**
     * The middleware for this route.
     *
     * @var array|null
     */
    protected array|null $middleware;

    /**
     * The messages for this route.
     *
     * @var class-string<Message>[]|null

The doc comment class-string<Message>[]|null at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Message>[]|null.

     */
    protected array|null $messages;

    /**
     * Whether the route is dynamic.
     *
     * @var bool
     */
    protected bool $dynamic = false;

    /**
     * Whether the route is secure.
     *
     * @var bool
     */
    protected bool $secure = false;

    /**
     * Whether the route is a redirect.
     *
     * @var bool
     */
    protected bool $redirect = false;

    /**
     * @inheritDoc
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * @inheritDoc
     */
    public function setPath(string $path): static
    {
        $this->path = $path;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function withPath(string $path): static
    {
        $route = clone $this;

        $route->path .= $path;

        return $route;
    }

    /**
     * @inheritDoc
     */
    public function withName(string $name): static
    {
        $route = clone $this;

        $currentName = $this->name ?? '';

        if ($name) {
            $route->name = $currentName
                ? "$currentName.$name"
                : $name;
        }

        return $route;
    }

    /**
     * @inheritDoc
     */
    public function getTo(): string|null
    {
        return $this->to ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setTo(string|null $to = null): static
    {
        $this->redirect = $to !== null;

        $this->to = $to;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getCode(): int|null
    {
        return $this->code ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setCode(int|null $code = null): static
    {
        $this->code = $code;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getMethods(): array
    {
        return $this->methods;
    }

    /**
     * @inheritDoc
     */
    public function setMethods(array $methods): static
    {
        // TODO: Change to use Method enum
        if (array_diff($methods, RequestMethod::ANY)) {
            throw new InvalidArgumentException('Invalid request methods set');
        }

        $this->methods = $methods;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getRegex(): string|null
    {
        return $this->regex ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setRegex(string|null $regex = null): static
    {
        $this->regex = $regex;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getParameters(): array
    {
        return $this->parameters ?? [];
    }

    /**
     * @inheritDoc
     */
    public function setParameters(array $parameters): static
    {
        // If this is an array of arrays vs an array of Parameter models
        if (is_array($parameters[0] ?? null)) {
            foreach ($parameters as $key => $parameter) {
                if (is_array($parameter)) {
                    // Convert each array to a Parameter model
                    $parameters[$key] = Parameter::fromArray($parameter);
                }
            }
        }

        /** @var Parameter[] $parameters */
        $this->__setParameters(...$parameters);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setParameter(Parameter $parameter): static
    {
        $this->parameters ??= [];

        $this->parameters[] = $parameter;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function addParameter(
        string $name,
        string|null $regex = null,
        Cast|null $cast = null,
        bool $isOptional = false,
        bool $shouldCapture = true,
        mixed $default = null
    ): static {
        return $this->setParameter(
            new Parameter(
                name: $name,
                regex: $regex ?? Regex::ANY,
                cast: $cast,
                isOptional: $isOptional,
                shouldCapture: $shouldCapture,
                default: $default
            )
        );
    }

    /**
     * @inheritDoc
     */
    public function getMiddleware(): array|null
    {
        return $this->middleware ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setMiddleware(array|null $middleware = null): static
    {
        $this->middleware = $middleware;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function withMiddleware(array $middleware): static
    {
        $route = clone $this;

        $route->middleware = array_merge($this->middleware ?? [], $middleware);

        return $route;
    }

    /**
     * @inheritDoc
     */
    public function getMessages(): array|null
    {
        return $this->messages ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setMessages(array|null $messages = null): static
    {
        $this->__setMessages(...$messages);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function withMessages(array $messages): static
    {
        $route = clone $this;

        $route->__setMessages(...array_merge($this->messages ?? [], $messages));

        return $route;
    }

    /**
     * @inheritDoc
     */
    public function withMessage(string $message): static
    {
        return $this->withMessages([$message]);
    }

    /**
     * @inheritDoc
     */
    public function isDynamic(): bool
    {
        return $this->dynamic;
    }

    /**
     * @inheritDoc
     */
    public function setDynamic(bool $dynamic = true): static
    {
        $this->dynamic = $dynamic;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isSecure(): bool
    {
        return $this->secure;
    }

    /**
     * @inheritDoc
     */
    public function setSecure(bool $secure = true): static
    {
        $this->secure = $secure;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isRedirect(): bool
    {
        return $this->redirect;
    }

    /**
     * @inheritDoc
     */
    public function setRedirect(bool $redirect): static
    {
        $this->redirect = $redirect;

        return $this;
    }

    /**
     * Set the parameters.
     *
     * @param array<int, Parameter> $parameters The parameters
     *
     * @return void
     */
    protected function __setParameters(Parameter ...$parameters): void
    {
        $this->parameters = $parameters;
    }

    /**
     * Set the messages.
     *
     * @param class-string<Message>[] $messages The messages

The doc comment class-string<Message>[] at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Message>[].

     *
     * @return void
     */
    protected function __setMessages(string ...$messages): void
    {
        foreach ($messages as $message) {
            assert(is_a($message, Message::class, true));
        }

        $this->messages = $messages;
    }
}