Jasny\Controller\Traits\Header

Complexity

Total Complexity

34

Size/Duplication

Total Lines	265
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	status()	0	12	2
A	created()	0	9	2
A	noContent()	0	7	3
A	back()	0	3	2
A	tooManyRequests()	0	3	1
A	notFound()	0	7	4
A	accepted()	0	3	1
A	conflict()	0	3	1
A	paymentRequired()	0	3	1
A	error()	0	7	3
A	badRequest()	0	7	3
A	notAcceptable()	0	3	1
A	header()	0	8	2
A	forbidden()	0	3	1
A	redirect()	0	12	3
A	unauthorized()	0	3	1
A	partialContent()	0	6	1
A	notModified()	0	3	1
A	ok()	0	3	1

<?php
declare(strict_types=1);

Missing file doc comment

namespace Jasny\Controller\Traits;

use Psr\Http\Message\ResponseInterface;

/**
 * Set HTTP response header.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait Header
{
    abstract protected function getResponse(): ResponseInterface;

Missing doc comment for function getResponse()

    abstract protected function setResponse(ResponseInterface $response): void;

Missing doc comment for function setResponse()

    abstract protected function getLocalReferer(): ?string;

Missing doc comment for function getLocalReferer()

    abstract protected function output(string $content, ?string $format = null): static;

Missing doc comment for function output()

    /**

Parameter $header should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $add should have a doc-comment as per coding-style.

     * Set a response header.
     *
     * @return $this
     */
    protected function header(string $header, string|int|\Stringable $value, bool $add = false): static
    {
        $response = $add
            ? $this->getResponse()->withAddedHeader($header, (string)$value)
            : $this->getResponse()->withHeader($header, (string)$value);
        $this->setResponse($response);

        return $this;
    }

    /**
     * Set the HTTP status code.
     * @link http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

There must be exactly one blank line before the tags in a doc comment

     *
     * Examples:
     * <code>
     *   $this->status(200);
     *   $this->status("200 Ok");
     * </code>
     *
     * @param int|string $status

Parameter tags must be defined first in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function status(int|string $status): static
    {
        if (is_string($status)) {
            [$status, $phrase] = explode(' ', $status, 2) + [1 => ''];
        } else {
            $phrase = '';
        }

        $response = $this->getResponse()->withStatus((int)$status, $phrase);
        $this->setResponse($response);

        return $this;
    }


    /**
     * Response with 200 Ok
     *
     * @return $this
     */
    protected function ok(): static
    {
        return $this->status(200);
    }

    /**
     * Response with created 201 code, and optionally the created location
     *
     * @param string|null $location  Url of created resource

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function created(?string $location = null): static
    {
        $this->status(201);

        if (!empty($location)) {

Construct empty() is not allowed. Use more strict comparison.

            $this->header('Location', $location);
        }

        return $this;
    }

    /**
     * Response with 202 Accepted
     */

Missing @return tag in function comment

    protected function accepted(): static
    {
        return $this->status(202);
    }

    /**
     * Response with 204 No Content
     *
     * @param int $status  204 (No Content) or 205 (Reset Content)

Expected 1 spaces after parameter name; 2 found

     */

Missing @return tag in function comment

    protected function noContent(int $status = 204): static
    {
        if ($status !== 204 && $status !== 205) {
            throw new \DomainException("Invalid status code $status for no content response");
        }

        return $this->status($status);
    }

    /**
     * Respond with a 206 Partial content with `Content-Range` header
     *
     * @param int $rangeFrom  Beginning of the range in bytes

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $rangeTo    End of the range in bytes

Expected 3 spaces after parameter name; 4 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $totalSize  Total size in bytes

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function partialContent(int $rangeFrom, int $rangeTo, int $totalSize): static
    {
        return $this
            ->status(206)
            ->header('Content-Range', "bytes {$rangeFrom}-{$rangeTo}/{$totalSize}")
            ->header('Content-Length', $rangeTo - $rangeFrom);
    }


    /**
     * Redirect to url and output a short message with the link
     *
     * @param string     $url

Missing parameter comment

     * @param int|string $status  301 (Moved Permanently), 302 (Found), 303 (See Other) or 307 (Temporary Redirect)

Expected 1 spaces after parameter name; 2 found

     */

Missing @return tag in function comment

    protected function redirect(string $url, int|string $status = 303): static
    {
        if ($status < 300 || $status >= 400) {
            throw new \DomainException("Invalid status code $status for redirect");
        }

        $urlHtml = htmlentities($url);

        return $this
            ->status($status)
            ->header('Location', $url)
            ->output('You are being redirected to <a href="' . $urlHtml . '">' . $urlHtml . '</a>', 'text/html');
    }

    /**
     * Redirect to previous page or to home page.
     *
     * @return $this
     */
    protected function back(): static
    {
        return $this->redirect($this->getLocalReferer() ?: '/');

Method Jasny\Controller\Controller::back() should return $this(Jasny\Controller\Controller) but returns static(Jasny\Controller\Controller).

Short ternary operator is not allowed. Use null coalesce operator if applicable or consider using long ternary.

Method Jasny\Controller\Guard::back() should return $this(Jasny\Controller\Guard) but returns static(Jasny\Controller\Guard).

    }

    /**
     * Respond with 304 Not Modified.
     *
     * @return $this
     */
    protected function notModified(): static
    {
        return $this->status(304);
    }


    /**
     * Respond with 400 Bad Request
     *
     * @param int $status  HTTP status code

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function badRequest(int $status = 400): static
    {
        if ($status < 400 || $status >= 500) {
            throw new \DomainException("Invalid status code $status for bad request response");
        }

        return $this->status($status);
    }

    /**
     * Respond with a 401 Unauthorized
     *
     * @return $this
     */
    protected function unauthorized(): static
    {
        return $this->status(401);
    }

    /**
     * Respond with 402 Payment Required
     *
     * @return $this
     */
    protected function paymentRequired(): static
    {
        return $this->status(402);
    }

    /**
     * Respond with 403 Forbidden
     *
     * @return $this
     */
    protected function forbidden(): static
    {
        return $this->status(403);
    }

    /**
     * Respond with 404 Not Found, 405 Method not allowed or 410 Gone
     *
     * @param int $status  404 (Not Found), 405 (Method not allowed) or 410 (Gone)

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function notFound(int $status = 404): static
    {
        if ($status !== 404 && $status !== 405 && $status !== 410) {
            throw new \DomainException("Invalid status code $status for no content response");
        }

        return $this->status($status);
    }

    /**
     * Respond with 406 Not Acceptable
     *
     * @return $this
     */
    protected function notAcceptable(): static
    {
        return $this->status(406);
    }

    /**
     * Respond with 409 Conflict
     *
     * @return $this
     */
    protected function conflict(): static
    {
        return $this->status(409);
    }

    /**
     * Respond with 429 Too Many Requests
     *
     * @return $this
     */
    protected function tooManyRequests(): static
    {
        return $this->status(429);
    }


    /**
     * Respond with a server error
     *
     * @param int $status  HTTP status code

Expected 1 spaces after parameter name; 2 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function error(int $status = 500): static
    {
        if ($status < 500 || $status >= 600) {
            throw new \DomainException("Invalid status code $status for server error response");
        }

        return $this->status($status);
    }

}