Parses the body of the request if it's not parsed and the method is POST, PUT or DELETE. It contains the following components to support different formats:

• JsonPayload
• UrlEncodePayload
• CsvPayload
• XmlPayload

Failure to parse the body will result in a Middlewares\Utils\HttpErrorException being thrown. See middlewares/utils for additional details.

• PHP >= 7.2
• A PSR-7 http library
• A PSR-15 middleware dispatcher

This package is installable and autoloadable via Composer as middlewares/payload.

composer require middlewares/payload

Parses the JSON payload of the request.

Dispatcher::run([
    (new Middlewares\JsonPayload())
        ->associative(false)
        ->depth(64)
]);

$response = $dispatcher->dispatch(new ServerRequest());

Contains the following options to configure the json_decode function:

Enabled by default, convert the objects into associative arrays.

//Disable associative arrays
$payload = (new Middlewares\JsonPayload())->associative(false);

To configure the recursion depth option of json_decode. By default is 512.

To pass the bitmask of json_decode options: JSON_BIGINT_AS_STRING (enabled by default), JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR.

To configure the allowed methods. By default only the requests with the method POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK are handled.

//Parse json only with POST and PUT requests
$payload = (new Middlewares\JsonPayload())->methods(['POST', 'PUT']);

To configure all Content-Type headers allowed in the request. By default is application/json

//Parse json only in request with these two Content-Type values
$payload = (new Middlewares\JsonPayload())->contentType(['application/json', 'text/json']);

To override the previous parsed body if exists (false by default)

Parses the url-encoded payload of the request.

Dispatcher::run([
    new Middlewares\UrlEncodePayload()
]);

To configure the allowed methods. By default only the requests with the method POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK are handled.

To configure all Content-Type headers allowed in the request. By default is application/x-www-form-urlencoded

To override the previous parsed body if exists (false by default)

CSV payloads are supported by the middlewares/csv-payload package.

Parses the XML payload of the request. Parsed body will return an instance of SimpleXMLElement.

To configure the allowed methods. By default only the requests with the method POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK are handled.

To configure all Content-Type headers allowed in the request. By default is text/xml, application/xml and application/x-xml.

To override the previous parsed body if exists (false by default)

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.