Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Response
+ Graphe d'héritage de Response:

Fonctions membres publiques

 __construct ($body='php://memory', int $status=200, array $headers=[])
 
 getStatusCode ()
 
 getReasonPhrase ()
 
 withStatus ($code, $reasonPhrase='')
 
- Fonctions membres publiques hérités de MessageInterface
 getProtocolVersion ()
 
 withProtocolVersion ($version)
 
 getHeaders ()
 
 hasHeader ($name)
 
 getHeader ($name)
 
 getHeaderLine ($name)
 
 withHeader ($name, $value)
 
 withAddedHeader ($name, $value)
 
 withoutHeader ($name)
 
 getBody ()
 
 withBody (StreamInterface $body)
 

Champs de données

const MIN_STATUS_CODE_VALUE = 100
 
const MAX_STATUS_CODE_VALUE = 599
 

Fonctions membres privées

 setStatusCode ($code, $reasonPhrase='')
 

Attributs privés

 $phrases
 
 $reasonPhrase
 
 $statusCode
 

Description détaillée

HTTP response encapsulation.

Responses are considered immutable; all methods that might change state are implemented such that they retain the internal state of the current message and return a new instance that contains the changed state.

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $body = 'php://memory',
int  $status = 200,
array  $headers = [] 
)
Paramètres
string | resource | StreamInterface$bodyStream identifier and/or actual stream resource
int$statusStatus code for the response, if any.
array$headersHeaders for the response, if any.
Exceptions
Exception

Références Laminas\Diactoros\getStream(), Laminas\Diactoros\setHeaders(), et Response\setStatusCode().

Documentation des fonctions membres

◆ getReasonPhrase()

getReasonPhrase ( )

{Gets the response reason phrase associated with the status code.Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml string Reason phrase; must return an empty string if none present.}

Implémente ResponseInterface.

Références Response\$reasonPhrase.

◆ getStatusCode()

getStatusCode ( )

{Gets the response status code.The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Renvoie
int Status code.
}

Implémente ResponseInterface.

Références Response\$statusCode.

Référencé par Response\__get().

◆ setStatusCode()

setStatusCode (   $code,
  $reasonPhrase = '' 
)
private

Set a valid status code.

Paramètres
int$code
string$reasonPhrase
Exceptions
Exception

Références Response\$reasonPhrase.

Référencé par Response\__construct().

◆ withStatus()

withStatus (   $code,
  $reasonPhrase = '' 
)

{Return an instance with the specified status code and, optionally, reason phrase.If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml int $code The 3-digit integer result code to set. string $reasonPhrase The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification. static For invalid status code arguments.}

Implémente ResponseInterface.

Références Response\$reasonPhrase, et $this.

Documentation des champs

◆ $phrases

$phrases
private
Valeur initiale :
= [
100 => 'Continue'

◆ $reasonPhrase

◆ $statusCode

$statusCode
private

◆ MAX_STATUS_CODE_VALUE

const MAX_STATUS_CODE_VALUE = 599

◆ MIN_STATUS_CODE_VALUE

const MIN_STATUS_CODE_VALUE = 100

La documentation de cette classe a été générée à partir du fichier suivant :