BlitzPHP\Http\Request

Complexity

Total Complexity

55

Size/Duplication

Total Lines	406
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	1	Features	0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	decodedPath()	0	3	1
A	secure()	0	3	1
A	toArray()	0	3	1
A	ajax()	0	3	1
A	userAgent()	0	3	1
A	replace()	0	5	1
A	getSchemeAndHttpHost()	0	3	1
A	fullUrlWithoutQuery()	0	7	2
A	offsetUnset()	0	3	1
A	getHost()	0	3	1
A	offsetSet()	0	3	1
A	fullUrl()	0	7	2
A	pjax()	0	3	1
A	url()	0	3	1
A	method()	0	3	1
A	routeIs()	0	3	1
A	path()	0	3	1
A	prefetch()	0	4	2
A	pathIs()	0	5	1
A	hasSession()	0	3	1
A	__isset()	0	3	1
A	getBaseUrl()	0	3	1
A	validate()	0	9	2
A	__get()	0	3	1
A	httpHost()	0	3	1
A	segment()	0	3	1
A	ip()	0	3	1
A	getPort()	0	3	1
A	setSession()	0	3	1
A	offsetExists()	0	3	1
A	isMethod()	0	9	3
A	getHttpHost()	0	10	5
A	merge()	0	5	1
A	fullUrlWithQuery()	0	7	2
A	getScheme()	0	3	1
A	offsetGet()	0	3	1
A	validation()	0	14	4
A	mergeIfMissing()	0	3	1
A	segments()	0	5	1
A	fullUrlIs()	0	5	1
A	root()	0	3	1

<?php

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

namespace BlitzPHP\Http;

use ArrayAccess;
use BlitzPHP\Container\Services;
use BlitzPHP\Contracts\Support\Arrayable;
use BlitzPHP\Exceptions\ValidationException;
use BlitzPHP\Session\Store;
use BlitzPHP\Utilities\Iterable\Arr;
use BlitzPHP\Utilities\String\Text;
use BlitzPHP\Validation\DataValidation;
use BlitzPHP\Validation\Validation;
use BlitzPHP\Validation\Validator;
use Dimtrovich\Validation\Exceptions\ValidationException as DimtrovichValidationException;
use Dimtrovich\Validation\ValidatedInput;
use InvalidArgumentException;

class Request extends ServerRequest implements Arrayable, ArrayAccess
{
    use Concerns\InteractsWithContentTypes;
    use Concerns\InteractsWithInput;
    use Concerns\InteractsWithFlashData;

    /**
     * Validation des donnees de la requete
     *
     * @param array|class-string<DataValidation> $rules

The doc comment array|class-string<DataValidation> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array|class-string<DataValidation>.

     */
    public function validate(array|string $rules, array $messages = []): ValidatedInput
    {
        try {
            return $this->validation($rules, $messages)->safe();
        } catch (DimtrovichValidationException $e) {
            $th = new ValidationException($e->getMessage());
            $th->setErrors($e->getErrors());

            throw $th;
        }
    }

    /**
     * Cree un validateur avec les donnees de la requete actuelle
     *
     * @param array|class-string<DataValidation> $rules

The doc comment array|class-string<DataValidation> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array|class-string<DataValidation>.

     */
    public function validation(array|string $rules, array $messages = []): Validation
    {
        if (is_string($rules)) {

The condition is_string($rules) is always false.

            if (! class_exists($rules) || ! is_subclass_of($rules, DataValidation::class)) {
                throw new InvalidArgumentException();
            }

            /** @var DataValidation $validation */
            $validation = Services::container()->make($rules);

            return $validation->process($this);
        }

        return Validator::make($this->all(), $rules, $messages);

The expression return BlitzPHP\Validation\Validator::make($this->all(), $rules, $messages) returns the type Dimtrovich\Validation\Validation which includes types incompatible with the type-hinted return BlitzPHP\Validation\Validation.

    }

    /**
     * Obtenez la méthode de requête.
     */
    public function method(): string
    {
        return $this->getMethod();
    }

    /**
     * Obtenez l'URL racine de l'application.
     */
    public function root(): string
    {
        return rtrim(site_url(), '/');
    }

    /**
     * Renvoie l'URL racine à partir de laquelle cette requête est exécutée.
     *
     * L'URL de base ne se termine jamais par un /.
     *
     * Ceci est similaire à getBasePath(), sauf qu'il inclut également le
     * nom de fichier du script (par exemple index.php) s'il existe.
     *
     * @return string L'URL brute (c'est-à-dire non décodée en url)
     */
    public function getBaseUrl(): string
    {
        return trim(config()->get('app.base_url'), '/');

It seems like config()->get('app.base_url') can also be of type null; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Obtient le schéma et l'hôte HTTP.
     *
     * Si l'URL a été appelée avec une authentification de base, l'utilisateur et
     * le mot de passe ne sont pas ajoutés à la chaîne générée.
     */
    public function getSchemeAndHttpHost(): string
    {
        return $this->getScheme() . '://' . $this->getHttpHost();
    }

    /**
     * Renvoie l'hôte HTTP demandé.
     *
     * Le nom du port sera ajouté à l'hôte s'il n'est pas standard.
     */
    public function getHttpHost(): string
    {
        $scheme = $this->getScheme();
        $port   = $this->getPort();

        if (('http' === $scheme && 80 === $port) || ('https' === $scheme && 443 === $port)) {
            return $this->getHost();
        }

        return $this->getHost() . ':' . $port;
    }

    /**
     * Obtenez l'URL (pas de chaîne de requête) pour la demande.
     */
    public function url(): string
    {
        return rtrim(preg_replace('/\?.*/', '', (string) $this->getUri()), '/');
    }

    /**
     * Obtenez l'URL complète de la demande.
     */
    public function fullUrl(): string
    {
        if (! empty($query = $this->getEnv('QUERY_STRING'))) {
            return $this->url() . '?' . $query;
        }

        return $this->url();
    }

    /**
     * Obtenez l'URL complète de la demande avec les paramètres de chaîne de requête ajoutés.
     */
    public function fullUrlWithQuery(array $query): string
    {
        $question = '?';

        return count($this->query()) > 0
            ? $this->url() . $question . Arr::query(array_merge($this->query(), $query))
            : $this->fullUrl() . $question . Arr::query($query);
    }

    /**
     * Obtenez l'URL complète de la requête sans les paramètres de chaîne de requête donnés.
     */
    public function fullUrlWithoutQuery(array|string $keys): string
    {
        $query = Arr::except($this->query(), $keys);

        return count($query) > 0
            ? $this->url() . '?' . Arr::query($query)
            : $this->url();
    }

    /**
     * Obtenez les informations de chemin actuelles pour la demande.
     */
    public function path(): string
    {
        return $this->getPath();
    }

    /**
     * Obtenez les informations de chemin décodées actuelles pour la demande.
     */
    public function decodedPath(): string
    {
        return rawurldecode($this->path());
    }

    /**
     * Obtenir un segment de l'URI (index basé sur 1).
     */
    public function segment(int $index, ?string $default = null): ?string
    {
        return Arr::get($this->segments(), $index - 1, $default);
    }

    /**
     * Obtenez tous les segments pour le chemin de la demande.
     */
    public function segments(): array
    {
        $segments = explode('/', $this->decodedPath());

        return array_values(array_filter($segments, static fn ($value) => $value !== ''));
    }

    /**
     * Déterminez si l’URI de la demande actuelle correspond à un modèle.
     */
    public function pathIs(...$patterns): bool
    {
        $path = $this->decodedPath();

        return collect($patterns)->contains(static fn ($pattern) => Text::is($pattern, $path));
    }

    /**
     * Déterminez si le nom de la route correspond à un modèle donné.
     *
     * @param mixed ...$patterns
     */
    public function routeIs(...$patterns): bool

The parameter $patterns is not used and could be removed.

    {
        return false;
        // return $this->route() && $this->route()->named(...$patterns);
    }

    /**
     * Verifier si la methode de la requete actuelle est l'une envoyee en parametre
     */
    public function isMethod(array|string $methods): bool
    {
        foreach ((array) $methods as $method) {
            if (strtolower($method) === strtolower($this->method())) {
                return true;
            }
        }

        return false;
    }

    /**
     * Déterminez si l'URL de requête et la chaîne de requête actuelles correspondent à un modèle.
     *
     * @param mixed ...$patterns
     */
    public function fullUrlIs(...$patterns): bool
    {
        $url = $this->fullUrl();

        return collect($patterns)->contains(static fn ($pattern) => Text::is($pattern, $url));
    }

    /**
     * Obtenez l'hôte HTTP demandé.
     */
    public function httpHost(): ?string
    {
        return $this->host();
    }

    /**
     * Déterminez si la demande est le résultat d'un appel AJAX.
     */
    public function ajax(): bool
    {
        return $this->is('ajax');
    }

    /**
     * Déterminez si la demande est le résultat d'un appel PJAX.
     */
    public function pjax(): bool
    {
        return $this->header('X-PJAX') === true;
    }

    /**
     * Déterminez si la demande est le résultat d'un appel de prélecture.
     */
    public function prefetch(): bool
    {
        return strcasecmp($this->server('HTTP_X_MOZ', ''), 'prefetch') === 0

It seems like $this->server('HTTP_X_MOZ', '') can also be of type array and null; however, parameter $string1 of strcasecmp() does only seem to accept string, maybe add an additional type check?

               || strcasecmp($this->header('Purpose', ''), 'prefetch') === 0;
    }

    /**
     * Déterminez si la demande est via HTTPS.
     */
    public function secure(): bool
    {
        return $this->is('ssl');
    }

    /**
     * Obtenez l'adresse IP du client.
     */
    public function ip(): ?string
    {
        return $this->clientIp();
    }

    /**
     * Obtenez l'agent utilisateur client.
     */
    public function userAgent(): ?string
    {
        return $this->header('User-Agent');
    }

    /**
     * Fusionne la nouvelle entrée dans le tableau d'entrée de la requête actuelle.
     */
    public function merge(array $input): self
    {
        $this->data = array_merge($this->data, $input);

It seems like $this->data can also be of type null and object; however, parameter $arrays of array_merge() does only seem to accept array, maybe add an additional type check?

        return $this;
    }

    /**
     * Fusionne la nouvelle entrée dans l'entrée de la requête, mais uniquement lorsque cette clé est absente de la requête.
     */
    public function mergeIfMissing(array $input): self
    {
        return $this->merge(collect($input)->filter(fn ($value, $key) => $this->missing($key))->toArray());
    }

    /**
     * Remplacez l'entrée de la requête en cours.
     */
    public function replace(array $input): self
    {
        $this->data = $input;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function hasSession(): bool
    {
        return null !== $this->session;
    }

    /**
     * Définissez l'instance de session sur la demande.
     */
    public function setSession(Store $session): void
    {
        $this->session = $session;
    }

    /**
     * Obtenez toutes les entrées et tous les fichiers de la requête.
     */
    public function toArray(): array
    {
        return $this->all();
    }

    public function getScheme(): string
    {
        return $this->getUri()->getScheme();
    }

    public function getHost(): string
    {
        return $this->getUri()->getHost();
    }

    public function getPort(): int
    {
        return $this->getUri()->getPort() ?? 80;
    }

    /**
     * {@inheritDoc}
     *
     * @param string $offset
     */
    public function offsetExists($offset): bool
    {
        return Arr::has($this->all(), $offset);
    }

    /**
     * {@inheritDoc}
     *
     * @param string $offset
     */
    public function offsetGet($offset): mixed
    {
        return $this->__get($offset);
    }

    /**
     * {@inheritDoc}
     *
     * @param string $offset
     */
    public function offsetSet($offset, $value): void
    {
        $this->data[$offset] = $value;
    }

    /**
     * {@inheritDoc}
     *
     * @param string $offset
     */
    public function offsetUnset($offset): void
    {
        unset($this->data[$offset]);
    }

    /**
     * Vérifiez si un élément d'entrée est défini sur la demande.
     */
    public function __isset(string $key): bool
    {
        return null !== $this->__get($key);
    }

    /**
     * Obtenez un élément d'entrée à partir de la requête.
     */
    public function __get(string $key): mixed
    {
        return Arr::get($this->all(), $key, null);
    }
}