Graphe d'héritage de ServerRequest:

Fonctions membres publiques
	__construct (string $method, $uri, array $headers=[], $body=null, string $version='1.1', array $serverParams=[])

	getServerParams ()

	getUploadedFiles ()

	withUploadedFiles (array $uploadedFiles)

	getCookieParams ()

	withCookieParams (array $cookies)

	getQueryParams ()

	withQueryParams (array $query)

	getParsedBody ()

	withParsedBody ($data)

	getAttributes ()

	getAttribute ($attribute, $default=null)

	withAttribute ($attribute, $value)

	withoutAttribute ($attribute)

Fonctions membres publiques hérités de RequestInterface
	getRequestTarget ()

	withRequestTarget ($requestTarget)

	getMethod ()

	withMethod ($method)

	getUri ()

	withUri (UriInterface $uri, $preserveHost=false)

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)

Attributs privés
	$attributes = []

	$cookieParams = []

	$parsedBody

	$queryParams = []

	$serverParams

	$uploadedFiles = []

Description détaillée

Auteur: Michael Dowling and contributors to guzzlehttp/psr7; Tobias Nyholm tobia.nosp@m.s.ny.nosp@m.holm@.nosp@m.gmai.nosp@m.l.com; Martijn van der Ven marti.nosp@m.jn@v.nosp@m.ander.nosp@m.ven..nosp@m.se

This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	string	$method,
			$uri,
		array	$headers = `[]`,
			$body = `null`,
		string	$version = `'1.1'`,
		array	$serverParams = `[]`
	)

Paramètres

string	$method	HTTP method
string \| UriInterface	$uri	URI
array	$headers	Request headers
string \| resource \| StreamInterface \| null	$body	Request body
string	$version	Protocol version
array	$serverParams	Typically the $_SERVER superglobal

Références $method, ServerRequest\$serverParams, Nyholm\Psr7\$uri, $version, Stream\create(), MessageInterface\hasHeader(), method, null, Nyholm\Psr7\setHeaders(), et Nyholm\Psr7\updateHostFromUri().

Documentation des fonctions membres

◆ getAttribute()

getAttribute	(	$attribute,
		$default = `null`
	)

Renvoie: mixed

Implémente ServerRequestInterface.

Références $default.

◆ getAttributes()

getAttributes ( )

Retrieve attributes derived from the request.

The request "attributes" may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.

Renvoie: array Attributes derived from the request.

Implémente ServerRequestInterface.

Références ServerRequest\$attributes.

◆ getCookieParams()

getCookieParams ( )

Retrieve cookies.

Retrieves cookies sent by the client to the server.

The data MUST be compatible with the structure of the $_COOKIE superglobal.

Renvoie: array

Implémente ServerRequestInterface.

Références ServerRequest\$cookieParams.

◆ getParsedBody()

getParsedBody ( )

Retrieve any parameters provided in the request body.

If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, this method MUST return the contents of $_POST.

Otherwise, this method may return any results of deserializing the request body content; as parsing returns structured content, the potential types MUST be arrays or objects only. A null value indicates the absence of body content.

Renvoie: null|array|object The deserialized body parameters, if any. These will typically be an array or object.

Implémente ServerRequestInterface.

Références ServerRequest\$parsedBody.

◆ getQueryParams()

getQueryParams ( )

Retrieve query string arguments.

Retrieves the deserialized query string arguments, if any.

Note: the query params might not be in sync with the URI or server params. If you need to ensure you are only getting the original values, you may need to parse the query string from getUri()->getQuery() or from the QUERY_STRING server param.

Renvoie: array

Implémente ServerRequestInterface.

Références ServerRequest\$queryParams.

◆ getServerParams()

getServerParams ( )

Retrieve server parameters.

Retrieves data related to the incoming request environment, typically derived from PHP's $_SERVER superglobal. The data IS NOT REQUIRED to originate from $_SERVER.

Renvoie: array

Implémente ServerRequestInterface.

Références ServerRequest\$serverParams.

◆ getUploadedFiles()

getUploadedFiles ( )

Retrieve normalized file upload data.

This method returns upload metadata in a normalized tree, with each leaf an instance of Psr.

These values MAY be prepared from $_FILES or the message body during instantiation, or MAY be injected via withUploadedFiles().

Renvoie: array An array tree of UploadedFileInterface instances; an empty array MUST be returned if no data is present.

Implémente ServerRequestInterface.

Références ServerRequest\$uploadedFiles.

◆ withAttribute()

withAttribute	(	$name,
		$value
	)

Return an instance with the specified derived request attribute.

This method allows setting a single derived request attribute as described in getAttributes().

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 attribute.

Voir également: getAttributes()

Paramètres

string	$name	The attribute name.
mixed	$value	The value of the attribute.

Renvoie: static

Implémente ServerRequestInterface.

Références $this, et $value.

◆ withCookieParams()

withCookieParams ( array $cookies )

Return an instance with the specified cookies.

The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST be compatible with the structure of $_COOKIE. Typically, this data will be injected at instantiation.

This method MUST NOT update the related Cookie header of the request instance, nor related values in the server params.

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 cookie values.

Paramètres

array $cookies Array of key/value pairs representing cookies.

Renvoie: static

Implémente ServerRequestInterface.

Références $this.

◆ withoutAttribute()

withoutAttribute ( $name )

Return an instance that removes the specified derived request attribute.

This method allows removing a single derived request attribute as described in getAttributes().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the attribute.

Voir également: getAttributes()

Paramètres

string $name The attribute name.

Renvoie: static

Implémente ServerRequestInterface.

Références $this.

◆ withParsedBody()

withParsedBody ( $data )

Return an instance with the specified body parameters.

These MAY be injected during instantiation.

If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, use this method ONLY to inject the contents of $_POST.

The data IS NOT REQUIRED to come from $_POST, but MUST be the results of deserializing the request body content. Deserialization/parsing returns structured data, and, as such, this method ONLY accepts arrays or objects, or a null value if nothing was available to parse.

As an example, if content negotiation determines that the request data is a JSON payload, this method could be used to create a request instance with the deserialized parameters.

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 body parameters.

Paramètres

null | array | object $data The deserialized body data. This will typically be in an array or object.

Renvoie: static

Exceptions

Implémente ServerRequestInterface.

Références $data, $this, et null.

◆ withQueryParams()

withQueryParams ( array $query )

Return an instance with the specified query string arguments.

These values SHOULD remain immutable over the course of the incoming request. They MAY be injected during instantiation, such as from PHP's $_GET superglobal, or MAY be derived from some other value such as the URI. In cases where the arguments are parsed from the URI, the data MUST be compatible with what PHP's parse_str() would return for purposes of how duplicate query parameters are handled, and how nested sets are handled.

Setting query string arguments MUST NOT change the URI stored by the request, nor the values in the server params.

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 query string arguments.

Paramètres

array $query Array of query string arguments, typically from $_GET.

Renvoie: static

Implémente ServerRequestInterface.

Références $query, et $this.

◆ withUploadedFiles()

withUploadedFiles ( array $uploadedFiles )

Create a new instance with the specified uploaded files.

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 body parameters.

Paramètres

array $uploadedFiles An array tree of UploadedFileInterface instances.