1. class
  2. Soosyze
  3. \
  4. Components
  5. \
  6. Http
  7. \
  8. Request

Request

class Request extends Message implements RequestInterface (View source)

Représentation d'une requête côté client sortant.

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.
protected string $requestTarget Cible de la requête.
protected UriInterface $uri L'URI de la requête.
protected string $methods Méthodes acceptés par le protocole HTTP.

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')

Pendant la construction, les implémentations DOIVENT essayer de définir l'en-tête Host à partir de un URI fourni si aucun en-tête Host n'est fourni.

string
getMethod()

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

string
getRequestTarget()

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

UriInterface
getUri()

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

Request
withMethod(string $method)

Renvoie une instance avec la méthode HTTP fournie.

Request
withRequestTarget(mixed $requestTarget)

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

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

Renvoie une instance avec l'URI fourni.

string
filterMethod(string $method)

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

Details

in Message at line 61
string getProtocolVersion()

Retourne la version du protocole HTTP.

Return Value

string

in Message at line 73
$this withProtocolVersion(string $version)

Renvoie une instance avec la version du protocole HTTP.

Parameters

string $version Version du protocole HTTP.

Return Value

$this

in Message at line 86
array getHeaders()

Renvoie le tableau d'en-tête.

Return Value

array

in Message at line 98
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.

in Message at line 111
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.

in Message at line 126
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.

in Message at line 141
$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

in Message at line 159
$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

in Message at line 180
$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

in Message at line 195
StreamInterface getBody()

Retourne le corp du message.

Return Value

StreamInterface Renvoie le corps en tant que flux.

in Message at line 207
$this withBody(StreamInterface $body)

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

Parameters

StreamInterface $body Le corp.

Return Value

$this

in Message at line 223
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.

in Message at line 237
protected withHeaders(array $headers)

Ajoute les en-têtes au message.

Parameters

array $headers

at line 75
__construct(string $method, UriInterface $uri, array $headers = [], StreamInterface $body = null, type $version = '1.1')

Pendant la construction, les implémentations DOIVENT essayer de définir l'en-tête Host à partir de un URI fourni si aucun en-tête Host n'est fourni.

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.

at line 98
string getMethod()

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

Return Value

string Renvoie la méthode de requête.

at line 110
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.

at line 136
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.

at line 149
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.

at line 167
Request withRequestTarget(mixed $requestTarget)

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

Parameters

mixed $requestTarget

Return Value

Request

at line 188
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

at line 216
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.