Yiisoft\Yii\Middleware\Redirect

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	process()	0	12	3
A	permanent()	0	5	1
A	toRoute()	0	6	1
A	__construct()	0	4	1
A	withStatus()	0	5	1
A	toUrl()	0	5	1
A	temporary()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Middleware;

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use RuntimeException;
use Yiisoft\Http\Status;
use Yiisoft\Router\UrlGeneratorInterface;

/**
 * This middleware generates and adds a `Location` header to the response.
 */
final class Redirect implements MiddlewareInterface
{
    private ?string $uri = null;
    private ?string $route = null;
    /**
     * @var array<string, scalar|\Stringable|null> $parameters
     */
    private array $parameters = [];
    private int $statusCode = Status::MOVED_PERMANENTLY;

    public function __construct(
        private ResponseFactoryInterface $responseFactory,
        private UrlGeneratorInterface $urlGenerator,
    ) {
    }

    /**
     * Returns a new instance with the specified URL for redirection.
     *
     * @param string $url URL for redirection.
     */
    public function toUrl(string $url): self
    {
        $new = clone $this;
        $new->uri = $url;
        return $new;
    }

    /**
     * Returns a new instance with the specified route data for redirection.
     *
     * If you've set a redirect URL with {@see toUrl()}, the middleware ignores the route data, since the URL
     * is a priority.
     *
     * @param string $name The route name for redirection.
     * @param array<string, scalar|\Stringable|null> $parameters $parameters The route parameters for redirection.
     */
    public function toRoute(string $name, array $parameters = []): self
    {
        $new = clone $this;
        $new->route = $name;
        $new->parameters = $parameters;
        return $new;
    }

    /**
     * Returns a new instance with the specified status code of the response for redirection.
     *
     * @param int $statusCode The status code of the response for redirection.
     */
    public function withStatus(int $statusCode): self
    {
        $new = clone $this;
        $new->statusCode = $statusCode;
        return $new;
    }

    /**
     * Returns a new instance with the response status code of permanent redirection.
     *
     * @see Status::MOVED_PERMANENTLY
     */
    public function permanent(): self
    {
        $new = clone $this;
        $new->statusCode = Status::MOVED_PERMANENTLY;
        return $new;
    }

    /**
     * Returns a new instance with the response status code of temporary redirection.
     *
     * @see Status::FOUND
     */
    public function temporary(): self
    {
        $new = clone $this;
        $new->statusCode = Status::FOUND;
        return $new;
    }

    /**
     * @inheritDoc
     *
     * @throws RuntimeException If the data for redirection wasn't set earlier.
     */
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        if ($this->route === null && $this->uri === null) {
            throw new RuntimeException('Either `toUrl()` or `toRoute()` method should be used.');
        }

        /** @psalm-suppress PossiblyNullArgument */
        $uri = $this->uri ?? $this->urlGenerator->generate($this->route, $this->parameters);

It seems like $this->route can also be of type null; however, parameter $name of Yiisoft\Router\UrlGeneratorInterface::generate() does only seem to accept string, maybe add an additional type check?

        return $this->responseFactory
            ->createResponse($this->statusCode)
            ->withAddedHeader('Location', $uri);
    }
}