public function ServerRequestInterface::withParsedBody in Zircon Profile 8.0

Same name and namespace in other branches

1. 8 vendor/psr/http-message/src/ServerRequestInterface.php \Psr\Http\Message\ServerRequestInterface::withParsedBody()

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.

Return value

self

Throws

\InvalidArgumentException if an unsupported argument type is provided.

2 methods override ServerRequestInterface::withParsedBody()

ServerRequest::withParsedBody in vendor/zendframework/zend-diactoros/src/ServerRequest.php

Return an instance with the specified body parameters.

ServerRequest::withParsedBody in vendor/symfony/psr-http-message-bridge/Tests/Fixtures/ServerRequest.php

Return an instance with the specified body parameters.

File

vendor/psr/http-message/src/ServerRequestInterface.php, line 197

Class

ServerRequestInterface

Representation of an incoming, server-side HTTP request.

Namespace

Psr\Http\Message

Code

public function withParsedBody($data);