class Redirect extends Response (View source)

Représentation d'une réponse sortante côté serveur provoquant une redirection.

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 int $code Code d'état. from Response
protected string $reasonPhrase Phrase de raison. from Response
protected array $reasonPhraseDefault Code d'état et phrases de raison autorisés. from Response
protected int[] $codeRedirectValid Codes de redirection valident.

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 $location, int $code = 301, StreamInterface $body = null, array $headers = [])

Construit une réponse de redirection.

string
__toString()

Renvoie les informations de la réponse et son contenu.

from Response
int
getStatusCode()

Obtient le code d'état de la réponse.

from Response
withStatus(int $code, string $reasonPhrase = '')

Renvoie une instance avec le code d'état spécifié et, éventuellement, une phrase de raison.

from Response
int
getReasonPhrase()

Obtient la phrase de raison de la réponse.

from Response
int
filtreCode(int $code = 301)

Redéfini filtreCode() afin que le code soit valide pour une redirection.

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 $location, int $code = 301, StreamInterface $body = null, array $headers = [])

Construit une réponse de redirection.

Parameters

string $location Url de redirection.
int $code Code d'état.
StreamInterface $body Corp de la réponse.
array $headers En-tête de la réponse.

string __toString()

Renvoie les informations de la réponse et son contenu.

Return Value

string

int getStatusCode()

Obtient le code d'état de la réponse.

Return Value

int Code d'état.

Response withStatus(int $code, string $reasonPhrase = '')

Renvoie une instance avec le code d'état spécifié et, éventuellement, une phrase de raison.

Parameters

int $code Code de résultat de l'entier à 3 chiffres à définir.
string $reasonPhrase La phrase de raison à utiliser avec le fourni le code d'état; si aucune n'est fournie, les mises en œuvre PEUVENT utiliser les valeurs par défaut comme suggéré dans la spécification HTTP.

Return Value

Response

Exceptions

InvalidArgumentException Pour les arguments de code d'état non valides.

int getReasonPhrase()

Obtient la phrase de raison de la réponse.

Return Value

int Code d'état.

protected int filtreCode(int $code = 301)

Redéfini filtreCode() afin que le code soit valide pour une redirection.

Parameters

int $code Code d'état.

Return Value

int Le code d'état filtré.

Exceptions

InvalidArgumentException Status code is invalid for redirect.