middlewares / payload

PSR-15 middleware to parse the body of the request with support for json, csv and url-encode

middlewares/payload

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.

Requirements

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

Installation

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

composer require middlewares/payload

JsonPayload

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:

associative

Enabled by default, convert the objects into associative arrays.

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

depth

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

options

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

methods

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']);

contentType

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']);

override

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

UrlEncodePayload

Parses the url-encoded payload of the request.

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

methods

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

contentType

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

override

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

CsvPayload

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

XmlPayload

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

methods

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

contentType

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

override

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.

payload's Issues

Cannot disable associative return in JsonPayload

The definition JsonPayload::parse(): array is incompatible with associative(false) flag, which could return any scalar type + array + object.

The return type should be dropped.

Allow to use an array with various content-type

Like methods(), it could be renamed to contentTypes() (plural):

(new Middlewares\JsonPayload())
    ->methods(['POST', 'PUT'])
    ->contentTypes(['application/json', 'text/json'])

Exception for UrlEncodePayload

Should we throw an exception if UrlEncodePayload fails?

I imagine something like the following:

    protected function parse(StreamInterface $stream): array
    {
        $string = (string) $stream;
        parse_str($string, $data);
        if (strlen($string) && empty($data)) {
            throw new Exception('Invalid url encoded string');
        }
        return $data ?: [];
    }

@shadowhand what do you think?

Add an option to override previous parsed body

Example:

$middleware[] = (new Middlewares\JsonPayload())->override();

Failure to parse body is hard to identify

When the body cannot be parsed the result is an empty HTTP 400 response, with no body. This makes it extremely hard to track where the source of the error is.

Allow to customize the methods allowed

Example:

$middleware[] = (new Middlewares\JsonPayload())->methods(['GET', 'POST']);