Référence de la classe ServerRequest

Graphe d'héritage de ServerRequest:

Fonctions membres publiques
	__construct (array $serverParams=[], array $uploadedFiles=[], $uri=null, string $method=null, $body='php://input', array $headers=[], array $cookies=[], array $queryParams=[], $parsedBody=null, string $protocol='1.1')
	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)

Fonctions membres privées
	validateUploadedFiles (array $uploadedFiles)

Attributs privés
	$attributes = []
	$cookieParams = []
	$parsedBody
	$queryParams = []
	$serverParams
	$uploadedFiles

Description détaillée

Server-side HTTP request

Extends the Request definition to add methods for accessing incoming data, specifically server parameters, cookies, matched path parameters, query string arguments, body parameters, and upload file information.

"Attributes" are discovered via decomposing the request (and usually specifically the URI path), and typically will be injected by the application.

Requests 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	(	array	$serverParams = [],
		array	$uploadedFiles = [],
			$uri = null,
		string	$method = null,
			$body = 'php://input',
		array	$headers = [],
		array	$cookies = [],
		array	$queryParams = [],
			$parsedBody = null,
		string	$protocol = '1.1'
	)

Paramètres

array	$serverParams	Server parameters, typically from $_SERVER
array	$uploadedFiles	Upload file information, a tree of UploadedFiles
null | string | UriInterface	$uri	URI for the request, if any.
null | string	$method	HTTP method for the request, if any.
string | resource | StreamInterface	$body	Message body, if any.
array	$headers	Headers for the message, if any.
array	$cookies	Cookies for the message, if any.
array	$queryParams	Query params for the message, if any.
null | array | object	$parsedBody	The deserialized body parameters, if any.
string	$protocol	HTTP protocol version.

Exceptions

Exception

Références Laminas\Diactoros\$method, ServerRequest\$parsedBody, Laminas\Diactoros\$protocol, ServerRequest\$queryParams, ServerRequest\$serverParams, ServerRequest\$uploadedFiles, Laminas\Diactoros\$uri, Laminas\Diactoros\initialize(), et ServerRequest\validateUploadedFiles().

Documentation des fonctions membres

getAttribute()

getAttribute	(		$attribute,
			$default = null
	)

{Retrieve a single derived request attribute.Retrieves a single derived request attribute as described in getAttributes(). If the attribute has not been previously set, returns the default value as provided.This method obviates the need for a hasAttribute() method, as it allows specifying a default value to return if the attribute is not found.

Voir également

getAttributes()

Paramètres

string	$name	The attribute name.
mixed	$default	Default value to return if the attribute does not exist.

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.

validateUploadedFiles()

validateUploadedFiles ( array  $uploadedFiles )

private

Recursively validate the structure in an uploaded files array.

Exceptions

Exception

Références ServerRequest\$uploadedFiles.

Référencé par ServerRequest\__construct(), et ServerRequest\withUploadedFiles().

withAttribute()

withAttribute	(		$attribute,
			$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

(

$attribute

)

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

Renvoie

static

Exceptions

}

Implémente ServerRequestInterface.

Références $this, ServerRequest\$uploadedFiles, et ServerRequest\validateUploadedFiles().

Documentation des champs

$attributes

$attributes = []

private

Référencé par ServerRequest\getAttributes().

$cookieParams

$cookieParams = []

private

Référencé par ServerRequest\getCookieParams().

$parsedBody

$parsedBody

private

Référencé par ServerRequest\__construct(), et ServerRequest\getParsedBody().

$queryParams

$queryParams = []

private

Référencé par ServerRequest\__construct(), et ServerRequest\getQueryParams().

$serverParams

$serverParams

private

Référencé par ServerRequest\__construct(), et ServerRequest\getServerParams().

$uploadedFiles

$uploadedFiles

private

Référencé par ServerRequest\__construct(), ServerRequest\getUploadedFiles(), ServerRequest\validateUploadedFiles(), et ServerRequest\withUploadedFiles().

---

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

• laminas/laminas-diactoros/src/ServerRequest.php