class ServerRequest extends Request implements ServerRequestInterface (View source)

Représentation d'une requête HTTP entrante, côté serveur.

Properties

protected string $protocolVersion Version du protocole (1.0|1.1|2.0|2). from Message
protected StreamInterface $body Corp du message. from Message
protected array $headers Les entêtes. from Message
protected string[] $protocols Protocoles pris en charges. from Message
protected string $method Méthode de la requête HTTP. from Request
protected string $requestTarget Cible de la requête. from Request
protected UriInterface $uri L'URI de la requête. from Request
protected string $methods Méthodes acceptés par le protocole HTTP. from Request
protected array $serverParams Paramètres du serveur ($_SERVER).
protected type $cookieParams Les cookies ($_COOKIE).
protected array $queryParams Paramètres de la requête ($_GET).
protected array $uploadFiles Fichiers transmis au serveur ($_FILES).
protected array $attributes Les attribues.
protected null|array|object $parseBody Le corps de la requête.

Methods

string
getProtocolVersion()

Retourne la version du protocole HTTP.

from Message
$this
withProtocolVersion(string $version)

Renvoie une instance avec la version du protocole HTTP.

from Message
array
getHeaders()

Renvoie le tableau d'en-tête.

from Message
bool
hasHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

from Message
string[]
getHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

from Message
string
getHeaderLine($name)

Récupère une chaîne de valeurs séparées par des virgules pour un seul en-tête.

from Message
$this
withHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en remplaçant l'en-tête spécifié.

from Message
$this
withAddedHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en ajoutant l'en-tête spécifié.

from Message
$this
withoutHeader(string $name)

Renvoie une instance sans l'en-tête spécifié.

from Message
StreamInterface
getBody()

Retourne le corp du message.

from Message
$this
withBody(StreamInterface $body)

Renvoie une instance avec le corps du message spécifié.

from Message
string
filterProtocolVersion(string $version)

Filtre la version du protocole.

from Message
withHeaders(array $headers)

Ajoute les en-têtes au message.

from Message
__construct(string $method, UriInterface $uri, array $headers = [], StreamInterface $body = null, type $version = '1.1', array $serverParams = [], array $cookies = [], array $uploadFiles = [])

Construit une requête coté serveur.

string
getMethod()

Récupère la méthode HTTP de la requête.

from Request
string
getRequestTarget()

Récupère la cible de requête telque les utilisateurs la voit.

from Request
UriInterface
getUri()

Récupère l'instance d'URI.

from Request
withMethod(string $method)

Renvoie une instance avec la méthode HTTP fournie.

from Request
withRequestTarget(mixed $requestTarget)

Renvoie une instance avec la cible de requête spécifique.

from Request
withUri(UriInterface $uri, bool $preserveHost = false)

Renvoie une instance avec l'URI fourni.

from Request
string
filterMethod(string $method)

Filtre la méthde HTTP de la requête.

from Request
static ServerRequest
create()

Construit une requête à partir des paramètre du serveur.

array
getServerParams()

Récupérer les paramètres du serveur.

array
getCookieParams()

Récupérer les cookies.

withCookieParams(array $cookies)

Renvoyer une instance avec les cookies spécifiés.

array
getQueryParams()

Récupérer les arguments de chaîne de requête.

withQueryParams(array $query)

Renvoie une instance avec les arguments de chaîne de requête spécifiés.

array
getUploadedFiles()

Récupérer les données de téléchargement de fichier normalisées.

withUploadedFiles(array $uploadedFiles)

Créer une nouvelle instance avec les fichiers téléchargés spécifiés.

null|array|object
getParsedBody()

Récupérer tous les paramètres fournis dans le corps de la requête.

withParsedBody(null|array|object $data)

Renvoie une instance avec les paramètres de corps spécifiés.

array
getAttributes()

Récupérer les attributs dérivés de la requête.

mélangé
getAttribute(string $name, mixed $default = null)

Récupérer un seul attribut de requête dérivé.

withAttribute(string $name, mixed $value)

Renvoie une instance avec l'attribut de requête dérivé spécifié.

withoutAttribute(string $name)

Renvoie une instance qui supprime l'attribut de requête dérivé spécifié.

static array
parseFiles(array $files)

Parse la variable supergloable $_FILES pour sa représentation PSR7 sans conversion des fichiers en instances de UploadedFileInterface.

static UploadedFileInterface[]
parseFilesToUploadFiles(array $files)

Parse la variable supergloable $_FILES pour sa représentation PSR7 avec conversion des fichiers en instances de UploadedFileInterface.

Details

string getProtocolVersion()

Retourne la version du protocole HTTP.

Return Value

string

$this withProtocolVersion(string $version)

Renvoie une instance avec la version du protocole HTTP.

Parameters

string $version Version du protocole HTTP.

Return Value

$this

array getHeaders()

Renvoie le tableau d'en-tête.

Return Value

array

bool hasHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

bool Renvoie true si l'en-tête est trouvé sinon faux.

string[] getHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

string[] Si l'en-tête est trouvé alors il est renvoyé toutes ses valeurs, sinon un tableau vide.

string getHeaderLine($name)

Récupère une chaîne de valeurs séparées par des virgules pour un seul en-tête.

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

string Si l'en-tête est trouvé alors il est renvoyé toutes les valeurs de l'en-tête concaténés par une virgule, sinon une chaine vide.

$this withHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en remplaçant l'en-tête spécifié.

Parameters

string $name Nom du champ d'en-tête insensible à la casse.
string|string[] $value Valeur(s) de l'en-tête.

Return Value

$this

$this withAddedHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en ajoutant l'en-tête spécifié.

Parameters

string $name Nom du champ d'en-tête insensible à la casse.
string|string[] $value Valeur(s) de l'en-tête.

Return Value

$this

$this withoutHeader(string $name)

Renvoie une instance sans l'en-tête spécifié.

Parameters

string $name Nom de champ d'en-tête insensible à la casse à supprimer.

Return Value

$this

StreamInterface getBody()

Retourne le corp du message.

Return Value

StreamInterface Renvoie le corps en tant que flux.

$this withBody(StreamInterface $body)

Renvoie une instance avec le corps du message spécifié.

Parameters

StreamInterface $body Le corp.

Return Value

$this

protected string filterProtocolVersion(string $version)

Filtre la version du protocole.

Parameters

string $version

Return Value

string Le protocole si celui-ci est conforme.

Exceptions

InvalidArgumentException Le protocole spécifié n'est pas valide.

protected withHeaders(array $headers)

Ajoute les en-têtes au message.

Parameters

array $headers

__construct(string $method, UriInterface $uri, array $headers = [], StreamInterface $body = null, type $version = '1.1', array $serverParams = [], array $cookies = [], array $uploadFiles = [])

Construit une requête coté serveur.

Parameters

string $method Méthode HTTP ('GET'|'POST'|...).
UriInterface $uri L'URI de la requête.
array $headers Les en-têtes du message.
StreamInterface $body Le corps du message.
type $version La version du protocole HTTP.
array $serverParams Paramètres de la requête.
array $cookies Les cookies.
array $uploadFiles Fichiers transmis au serveur.

string getMethod()

Récupère la méthode HTTP de la requête.

Return Value

string Renvoie la méthode de requête.

string getRequestTarget()

Récupère la cible de requête telque les utilisateurs la voit.

Si aucune adresse URI n'est disponible et qu'aucune cible de requête n'a été spécifiée cette méthode DOIT retourner la chaîne "/".

Return Value

string Cible ce la requête.

UriInterface getUri()

Récupère l'instance d'URI.

Cette méthode DOIT retourner une instance d'UriInterface.

Return Value

UriInterface Renvoie une instance d'UriInterface représentant l'URI de la requête.

Request withMethod(string $method)

Renvoie une instance avec la méthode HTTP fournie.

Parameters

string $method Nom de la méthode (sensible à la casse).

Return Value

Request

Exceptions

InvalidArgumentException pour les méthodes HTTP invalides.

Request withRequestTarget(mixed $requestTarget)

Renvoie une instance avec la cible de requête spécifique.

Parameters

mixed $requestTarget

Return Value

Request

Request withUri(UriInterface $uri, bool $preserveHost = false)

Renvoie une instance avec l'URI fourni.

Parameters

UriInterface $uri Nouvelle requête URI à utiliser.
bool $preserveHost Préserve l'état d'origine de l'en-tête Host.

Return Value

Request

protected string filterMethod(string $method)

Filtre la méthde HTTP de la requête.

Parameters

string $method Méthode HTTP ('GET'|'POST'|...).

Return Value

string Méthode HTTP filtré.

Exceptions

InvalidArgumentException La méthode doit être une chaine de caractère.
InvalidArgumentException La méthode n'est pas prise en charge par la requête.

static ServerRequest create()

Construit une requête à partir des paramètre du serveur.

Return Value

ServerRequest

array getServerParams()

Récupérer les paramètres du serveur.

Récupère les données liées à l'environnement de demande entrante, typiquement dérivé de superglobal $_SERVER de PHP. Les données ne sont PAS REQUIS pour provenir de $_SERVER.

Return Value

array

array getCookieParams()

Récupérer les cookies.

Récupère les cookies envoyés par le client au serveur.

Les données DOIVENT être compatibles avec la structure du $_COOKIE superglobal.

Return Value

array

ServerRequest withCookieParams(array $cookies)

Renvoyer une instance avec les cookies spécifiés.

Les données ne sont PAS OBLIGATOIRES pour provenir de la superglobale $_COOKIE, mais DOIVENT être compatible avec la structure de $_COOKIE. Typiquement, ces données seront être injecté à l'instanciation.

Parameters

array $cookies Tableau de paires clé/valeur représentant les cookies.

Return Value

ServerRequest

array getQueryParams()

Récupérer les arguments de chaîne de requête.

Remarque: les paramètres de requête peuvent ne pas être synchronisés avec l'URI ou le serveur params. Si vous devez vous assurer que vous n'obtenez que l'original valeurs, vous devrez peut-être analyser la chaîne de requête à partir de getUri()->getQuery() ou à partir du paramètre du serveur QUERY_STRING.

Return Value

array

ServerRequest withQueryParams(array $query)

Renvoie une instance avec les arguments de chaîne de requête spécifiés.

Parameters

array $query Tableau d'arguments de chaîne de requête, généralement de $_GET.

Return Value

ServerRequest

array getUploadedFiles()

Récupérer les données de téléchargement de fichier normalisées.

Ces valeurs PEUVENT être préparées à partir de $_FILES ou du corps du message pendant instanciation, ou PEUT être injecté via withUploadedFiles().

Return Value

array Arbre de tableau des instances de UploadedFileInterface; un vide Le tableau DOIT être retourné si aucune donnée n'est présente.

ServerRequest withUploadedFiles(array $uploadedFiles)

Créer une nouvelle instance avec les fichiers téléchargés spécifiés.

Parameters

array $uploadedFiles Arbre de tableau des instances de UploadedFileInterface.

Return Value

ServerRequest

Exceptions

InvalidArgumentException Les contenus doivent être tous des instance d'UploadedFileInterface.

null|array|object getParsedBody()

Récupérer tous les paramètres fournis dans le corps de la requête.

Return Value

null|array|object Les paramètres de corps désérialisés, le cas échéant. Ceux-ci seront généralement un tableau ou un objet.

ServerRequest withParsedBody(null|array|object $data)

Renvoie une instance avec les paramètres de corps spécifiés.

Si la demande Content-Type est soit application / x-www-form-urlencoded ou multipart / form-data, et la méthode de requête est POST, utilisez cette méthode SEULEMENT pour injecter le contenu de $_POST.

Parameters

null|array|object $data Données du corps désérialisées.

Return Value

ServerRequest

Exceptions

InvalidArgumentException Si un type d'argument non pris en charge est à condition de.

array getAttributes()

Récupérer les attributs dérivés de la requête.

La requête "attributs" peut être utilisée pour permettre l'injection de paramètres dérivés de la requête: par exemple, les résultats du chemin opérations de correspondance; les résultats des cookies décryptés; les résultats de désérialiser des corps de message codés sans forme; etc. Attributs sera spécifique à l'application et à la demande, et peut être mutable.

Return Value

array Attributs dérivés de la requête.

mélangé getAttribute(string $name, mixed $default = null)

Récupérer un seul attribut de requête dérivé.

Récupère un seul attribut de requête dérivé comme décrit dans getAttributes(). Si l'attribut n'a pas été défini précédemment, renvoie la valeur par défaut fournie.

Parameters

string $name Nom de l'attribut.
mixed $default Valeur par défaut à renvoyer si l'attribut n'existe pas.

Return Value

mélangé

See also

getAttributes()

ServerRequest withAttribute(string $name, mixed $value)

Renvoie une instance avec l'attribut de requête dérivé spécifié.

Cette méthode permet de définir un seul attribut de requête dérivé décrit dans getAttributes().

Cette méthode DOIT être mise en œuvre de manière à conserver les immutabilité du message, et DOIT retourner une instance qui a le attribut mis à jour.

Parameters

string $name Nom de l'attribut.
mixed $value Valeur de l'attribut.

Return Value

ServerRequest

See also

getAttributes()

ServerRequest withoutAttribute(string $name)

Renvoie une instance qui supprime l'attribut de requête dérivé spécifié.

Cette méthode permet de supprimer un seul attribut de requête dérivé décrit dans getAttributes().

Parameters

string $name Nom de l'attribut.

Return Value

ServerRequest

See also

getAttributes()

static array parseFiles(array $files)

Parse la variable supergloable $_FILES pour sa représentation PSR7 sans conversion des fichiers en instances de UploadedFileInterface.

N'appartient pas aux définitions des interfaces PSR7.

Parameters

array $files

Return Value

array

See also

https://www.php-fig.org/psr/psr-7/#16-uploaded-files

static UploadedFileInterface[] parseFilesToUploadFiles(array $files)

Parse la variable supergloable $_FILES pour sa représentation PSR7 avec conversion des fichiers en instances de UploadedFileInterface.

N'appartient pas aux définitions des interfaces PSR7.

Parameters

array $files

Return Value

UploadedFileInterface[]

See also

https://www.php-fig.org/psr/psr-7/#16-uploaded-files