ResponseTrait::header() - Code Metrics - Inspection of "cs-fix" - blitz-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( cd5116...99c066 )

by Dimitri
created 2023-11-27 18:53 UTC
ResponseTrait::header() A

↳ Parent: ResponseTrait
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	1
CRAP Score	2.5
Importance

Changes
Metric	Value
cc	2
eloc	3
nc	2
nop	3
dl	0
loc	7
ccs	1
cts	2
cp	0.5
crap	2.5
rs	10
c	0
b	0
f	0
<?php

/**
 * This file is part of Blitz PHP framework.
 *
 * (c) 2022 Dimitri Sitchet Tomkeu <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace BlitzPHP\Http\Concerns;

use BlitzPHP\Contracts\Http\StatusCode;
use BlitzPHP\Contracts\Session\CookieInterface;
use BlitzPHP\Formatter\Formatter;
use DateTime;
use DateTimeZone;
use GuzzleHttp\Psr7\Utils;
use InvalidArgumentException;

trait ResponseTrait
{
    /**
     * Obtient le code d'état de la réponse.
     */
    public function status(): int
    {
        return $this->getStatusCode();
        return $this->/** @scrutinizer ignore-call */ getStatusCode();
    }

    /**
     * Obtient la phrase de motif de réponse associée au code d'état.
     */
    public function statusText(): string
    {
        return $this->getReasonPhrase();
        return $this->/** @scrutinizer ignore-call */ getReasonPhrase();
    }

    /**
     * Obtient le contenu de la réponse
     */
    public function content(): string
    {
        return $this->getBody()->getContents();
        return $this->/** @scrutinizer ignore-call */ getBody()->getContents();
    }

    /**
     * Définissez un en-tête sur la réponse.
     *
     * @param string|string[] $values
     */
    public function header(string $key, array|string $values, bool $replace = true): static
    {
        if ($replace) {
            return $this->withHeader($key, $values);
            return $this->/** @scrutinizer ignore-call */ withHeader($key, $values);
        }

        return $this->withAddedHeader($key, $values);
        return $this->/** @scrutinizer ignore-call */ withAddedHeader($key, $values);
    }

    /**
     * Ajoutez un cookie à la réponse.
     *
     * @param CookieInterface|string $cookie
     */
    public function cookie($cookie): static
    {
        if (is_string($cookie) && function_exists('cookie')) {
            $cookie = cookie(...func_get_args());
            $cookie = cookie(/** @scrutinizer ignore-type */ ...func_get_args());
        }

        return $this->withCookie($cookie);
        return $this->/** @scrutinizer ignore-call */ withCookie($cookie);
    }

    /**
     * Définit l'en-tête de date
     */
    public function withDate(DateTime $date): self
    {
        $date->setTimezone(new DateTimeZone('UTC'));

        return $this->withHeader('Date', $date->format('D, d M Y H:i:s') . ' GMT');
    }

    /**
     * Convertit le $body en JSON et définit l'en-tête Content Type.
     */
    public function json(array|string $body, int $status = StatusCode::OK): self
    {
        return $this->withType('application/json')
        return $this->/** @scrutinizer ignore-call */ withType('application/json')
            ->withStringBody(Formatter::type('json')->format($body))
            ->withStatus($status);
    }

    /**
     * Renvoie le corps actuel, converti en JSON s'il ne l'est pas déjà.
     *
     * @throws InvalidArgumentException Si la propriété body n'est pas un json valide.
     */
    public function toJson(): array
    {
        $body = $this->getBody()->getContents();

        return Formatter::type('json')->parse($body);
    }

    /**
     * Convertit $body en XML et définit le Content-Type correct.
     */
    public function xml(array|string $body, int $status = StatusCode::OK): self
    {
        return $this->withType('application/xml')
            ->withStringBody(Formatter::type('xml')->format($body))
            ->withStatus($status);
    }

    /**
     * Récupère le corps actuel dans XML et le renvoie.
     */
    public function toXml()
    {
        $body = $this->getBody()->getContents();

        return Formatter::type('xml')->parse($body);
    }

    /**
     * Définit les en-têtes appropriés pour garantir que cette réponse n'est pas mise en cache par les navigateurs.
     *
     * @todo Recommander la recherche de ces directives, pourrait avoir besoin: 'private', 'no-transform', 'no-store', 'must-revalidate'
     */
    public function noCache(): self
    {
        return $this->withoutHeader('Cache-Control')
        return $this->/** @scrutinizer ignore-call */ withoutHeader('Cache-Control')
            ->withHeader('Cache-Control', ['no-store', 'max-age=0', 'no-cache']);
    }

    /**
     * Génère les en-têtes qui forcent un téléchargement à se produire.
     * Et envoie le fichier au navigateur.
     *
     * @param string      $filename Le nom que vous souhaitez donner au fichier téléchargé ou le chemin d'accès au fichier à envoyer
     * @param string|null $data     Les données à télécharger. Définissez null si le $filename est le chemin du fichier
     */
    public function download(string $filename, ?string $data = ''): static
    {
        if (is_file($filename)) {
            $filepath = realpath($filename);
            $filename = explode('/', str_replace(DIRECTORY_SEPARATOR, '/', $filename));
            $filename = end($filename);

            return $this->withFile($filepath, ['download' => true, 'name' => $filename]);
            return $this->/** @scrutinizer ignore-call */ withFile($filepath, ['download' => true, 'name' => $filename]);
        }

        if (! empty($data)) {
            return $this->withStringBody($data)
            return $this->/** @scrutinizer ignore-call */ withStringBody($data)
                ->withType(pathinfo($filename, PATHINFO_EXTENSION))
                ->withDownload($filename);
        }

        return $this;
    }

    /**
     * Renvoi une vue comme reponse
     */
    public function view(string $view, array $data = [], array|int $optionsOrStatus = StatusCode::OK): static
    {
        if (is_int($optionsOrStatus)) {
            $status  = $optionsOrStatus;
            $options = [];
        } else {
            $status  = $optionsOrStatus['status'] ?? StatusCode::OK;
            $options = array_filter($optionsOrStatus, static fn ($k) => $k !== 'status', ARRAY_FILTER_USE_KEY);
        }

        $viewContent = view($view, $data, $options)->get();

        return $this->withStatus($status)->withBody(Utils::streamFor($viewContent));
        return $this->/** @scrutinizer ignore-call */ withStatus($status)->withBody(Utils::streamFor($viewContent));
    }
}

blitz-php / framework

Push — main ( cd5116...99c066 )

ResponseTrait::header() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
