Representation of an incoming, server-side HTTP request. More...

Inheritance diagram for Psr\Http\Message\ServerRequestInterface:

Collaboration diagram for Psr\Http\Message\ServerRequestInterface:

Public Member Functions
	getServerParams ()
	Retrieve server parameters. More...

	getCookieParams ()
	Retrieve cookies. More...

	withCookieParams (array $cookies)
	Return an instance with the specified cookies. More...

	getQueryParams ()
	Retrieve query string arguments. More...

	withQueryParams (array $query)
	Return an instance with the specified query string arguments. More...

	getUploadedFiles ()
	Retrieve normalized file upload data. More...

	withUploadedFiles (array $uploadedFiles)
	Create a new instance with the specified uploaded files. More...

	getParsedBody ()
	Retrieve any parameters provided in the request body. More...

	withParsedBody ($data)
	Return an instance with the specified body parameters. More...

	getAttributes ()
	Retrieve attributes derived from the request. More...

	getAttribute ($name, $default=null)
	Retrieve a single derived request attribute. More...

	withAttribute ($name, $value)
	Return an instance with the specified derived request attribute. More...

	withoutAttribute ($name)
	Return an instance that removes the specified derived request attribute. More...

Public Member Functions inherited from Psr\Http\Message\RequestInterface
	getRequestTarget ()
	Retrieves the message's request target. More...

	withRequestTarget ($requestTarget)
	Return an instance with the specific request-target. More...

	getMethod ()
	Retrieves the HTTP method of the request. More...

	withMethod ($method)
	Return an instance with the provided HTTP method. More...

	getUri ()
	Retrieves the URI instance. More...

	withUri (UriInterface $uri, $preserveHost=false)
	Returns an instance with the provided URI. More...

Public Member Functions inherited from Psr\Http\Message\MessageInterface
	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string. More...

	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version. More...

	getHeaders ()
	Retrieves all message header values. More...

	hasHeader ($name)
	Checks if a header exists by the given case-insensitive name. More...

	getHeader ($name)
	Retrieves a message header value by the given case-insensitive name. More...

	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header. More...

	withHeader ($name, $value)
	Return an instance with the provided value replacing the specified header. More...

	withAddedHeader ($name, $value)
	Return an instance with the specified header appended with the given value. More...

	withoutHeader ($name)
	Return an instance without the specified header. More...

	getBody ()
	Gets the body of the message. More...

	withBody (StreamInterface $body)
	Return an instance with the specified message body. More...

Detailed Description

Representation of an incoming, server-side HTTP request.

Per the HTTP specification, this interface includes properties for each of the following:

Protocol version
HTTP method
URI
Headers
Message body

Additionally, it encapsulates all data as it has arrived to the application from the CGI and/or PHP environment, including:

The values represented in $_SERVER.
Any cookies provided (generally via $_COOKIE)
Query string arguments (generally via $_GET, or as parsed via parse_str())
Upload files, if any (as represented by $_FILES)
Deserialized body parameters (generally from $_POST)

$_SERVER values MUST be treated as immutable, as they represent application state at the time of request; as such, no methods are provided to allow modification of those values. The other values provide such methods, as they can be restored from $_SERVER or the request body, and may need treatment during the application (e.g., body parameters may be deserialized based on content type).

Additionally, this interface recognizes the utility of introspecting a request to derive and match additional parameters (e.g., via URI path matching, decrypting cookie values, deserializing non-form-encoded body content, matching authorization headers to users, etc). These parameters are stored in an "attributes" property.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Definition at line 43 of file ServerRequestInterface.php.

Member Function Documentation

◆ getAttribute()

Psr\Http\Message\ServerRequestInterface::getAttribute	(	$name,
		$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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

Referenced by Slim\App\processInvalidMethod(), and Slim\App\respond().

Here is the caller graph for this function:

◆ getAttributes()

Psr\Http\Message\ServerRequestInterface::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.

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ getCookieParams()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ getParsedBody()

Psr\Http\Message\ServerRequestInterface::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.

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

Referenced by ILIAS\UI\Implementation\Component\Input\Container\Form\PostDataFromServerRequest\__construct().

Here is the caller graph for this function:

◆ getQueryParams()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ getServerParams()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ getUploadedFiles()

Psr\Http\Message\ServerRequestInterface::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().

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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ withAttribute()

Psr\Http\Message\ServerRequestInterface::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.

See also: getAttributes()

Parameters

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

Returns: static

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

Referenced by Slim\Handlers\Strategies\RequestResponse\__invoke(), and Slim\App\dispatchRouterAndPrepareRoute().

Here is the caller graph for this function:

◆ withCookieParams()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ withoutAttribute()

Psr\Http\Message\ServerRequestInterface::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.

See also: getAttributes()

Parameters

string $name The attribute name.

Returns: static

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ withParsedBody()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ withQueryParams()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

◆ withUploadedFiles()

Psr\Http\Message\ServerRequestInterface::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

Implemented in Slim\Http\Request, and GuzzleHttp\Psr7\ServerRequest.

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

libs/composer/vendor/psr/http-message/src/ServerRequestInterface.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ getAttribute()

◆ getAttributes()

◆ getCookieParams()

◆ getParsedBody()

◆ getQueryParams()

◆ getServerParams()

◆ getUploadedFiles()

◆ withAttribute()

◆ withCookieParams()

◆ withoutAttribute()

◆ withParsedBody()

◆ withQueryParams()

◆ withUploadedFiles()