Inheritance diagram for GuzzleHttp\Psr7\ServerRequest:

Public Member Functions
	__construct ( $method, $uri, array $headers=[], $body=null, $version='1.1', array $serverParams=[])

	getAttribute ($attribute, $default=null)

	getAttributes ()

	getCookieParams ()

	getParsedBody ()

	getQueryParams ()

	getServerParams ()

	getUploadedFiles ()

	withAttribute ($attribute, $value)

	withCookieParams (array $cookies)

	withoutAttribute ($attribute)

	withParsedBody ($data)

	withQueryParams (array $query)

	withUploadedFiles (array $uploadedFiles)

Public Member Functions inherited from GuzzleHttp\Psr7\Request
	__construct ( $method, $uri, array $headers=[], $body=null, $version='1.1')

	getMethod ()

	getRequestTarget ()

	getUri ()

	withMethod ($method)

	withRequestTarget ($requestTarget)

	withUri (UriInterface $uri, $preserveHost=false)

Public Member Functions inherited from Psr\Http\Message\MessageInterface
	getBody ()

	getHeader ($name)

	getHeaderLine ($name)

	getHeaders ()

	getProtocolVersion ()

	hasHeader ($name)

	withAddedHeader ($name, $value)

	withBody (StreamInterface $body)

	withHeader ($name, $value)

	withoutHeader ($name)

	withProtocolVersion ($version)

Static Public Member Functions
static	fromGlobals ()

static	getUriFromGlobals ()

static	normalizeFiles (array $files)

Detailed Description

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.

Definition at line 25 of file ServerRequest.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\ServerRequest::__construct	(		$method,
			$uri,
		array	$headers = `[]`,
			$body = `null`,
			$version = `'1.1'`,
		array	$serverParams = `[]`
	)

Parameters

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

Definition at line 83 of file ServerRequest.php.

Member Function Documentation

◆ fromGlobals()

static GuzzleHttp\Psr7\ServerRequest::fromGlobals ( )

static

Return a ServerRequest populated with superglobals: $_GET $_POST $_COOKIE $_FILES $_SERVER

Returns: ServerRequestInterface

Definition at line 184 of file ServerRequest.php.

References GuzzleHttp\Psr7\ServerRequest\getUriFromGlobals().

◆ getAttribute()

GuzzleHttp\Psr7\ServerRequest::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.

See also: getAttributes()

Parameters

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

Returns: mixed

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 360 of file ServerRequest.php.

◆ getAttributes()

GuzzleHttp\Psr7\ServerRequest::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.

Returns: array Attributes derived from the request.

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 352 of file ServerRequest.php.

◆ getCookieParams()

GuzzleHttp\Psr7\ServerRequest::getCookieParams ( )

{Retrieve cookies.Retrieves cookies sent by the client to the server.The data MUST be compatible with the structure of the $_COOKIE superglobal.

Returns: array

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 295 of file ServerRequest.php.

◆ getParsedBody()

GuzzleHttp\Psr7\ServerRequest::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.

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

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 333 of file ServerRequest.php.

◆ getQueryParams()

GuzzleHttp\Psr7\ServerRequest::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.

Returns: array

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 314 of file ServerRequest.php.

◆ getServerParams()

GuzzleHttp\Psr7\ServerRequest::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.

Returns: array

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 268 of file ServerRequest.php.

◆ getUploadedFiles()

GuzzleHttp\Psr7\ServerRequest::getUploadedFiles ( )

{Retrieve normalized file upload data.This method returns upload metadata in a normalized tree, with each leaf an instance of Psr\Http\Message\UploadedFileInterface.These values MAY be prepared from $_FILES or the message body during instantiation, or MAY be injected via withUploadedFiles().

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

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 276 of file ServerRequest.php.

◆ getUriFromGlobals()

static GuzzleHttp\Psr7\ServerRequest::getUriFromGlobals ( )

static

Get a Uri populated with values from $_SERVER.

Returns: UriInterface

Definition at line 220 of file ServerRequest.php.

Referenced by GuzzleHttp\Psr7\ServerRequest\fromGlobals().

◆ normalizeFiles()

static GuzzleHttp\Psr7\ServerRequest::normalizeFiles ( array $files )

static

Return an UploadedFile instance array.

Parameters

array $files A array which respect $_FILES structure

Exceptions

InvalidArgumentException for unrecognized values

Returns: array

Definition at line 103 of file ServerRequest.php.

◆ withAttribute()

GuzzleHttp\Psr7\ServerRequest::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.

See also: getAttributes()

Parameters

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

Returns: static

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 372 of file ServerRequest.php.

◆ withCookieParams()

GuzzleHttp\Psr7\ServerRequest::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.

Parameters

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

Returns: static

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 303 of file ServerRequest.php.

◆ withoutAttribute()

GuzzleHttp\Psr7\ServerRequest::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.

See also: getAttributes()

Parameters

string $name The attribute name.

Returns: static

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 383 of file ServerRequest.php.

◆ withParsedBody()

GuzzleHttp\Psr7\ServerRequest::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.

Parameters

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

Returns: static

Exceptions

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 341 of file ServerRequest.php.

◆ withQueryParams()

GuzzleHttp\Psr7\ServerRequest::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.

Parameters

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

Returns: static

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 322 of file ServerRequest.php.

◆ withUploadedFiles()

GuzzleHttp\Psr7\ServerRequest::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.

Parameters

array $uploadedFiles An array tree of UploadedFileInterface instances.

Returns: static

Exceptions

}

Implements Psr\Http\Message\ServerRequestInterface.

Definition at line 284 of file ServerRequest.php.

The documentation for this class was generated from the following file:

ServerRequest.php

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fromGlobals()

◆ getAttribute()

◆ getAttributes()

◆ getCookieParams()

◆ getParsedBody()

◆ getQueryParams()

◆ getServerParams()

◆ getUploadedFiles()

◆ getUriFromGlobals()

◆ normalizeFiles()

◆ withAttribute()

◆ withCookieParams()

◆ withoutAttribute()

◆ withParsedBody()

◆ withQueryParams()

◆ withUploadedFiles()