middlewares/payload

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

middlewares/payload

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

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:, _(*2)

• JsonPayload
• UrlEncodePayload
• CsvPayload
• XmlPayload

Failure to parse the body will result in a Middlewares\Utils\HttpErrorException being thrown. See middlewares/utils for additional details., _(*3)

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., _(*4)

composer require middlewares/payload

JsonPayload

Parses the JSON payload of the request., _(*5)

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

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

Contains the following options to configure the json_decode function:, _(*6)

associative

Enabled by default, convert the objects into associative arrays., _(*7)

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

depth

To configure the recursion depth option of json_decode. By default is 512., _(*8)

options

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

methods

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

//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, _(*11)

//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), _(*12)

UrlEncodePayload

Parses the url-encoded payload of the request., _(*13)

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., _(*14)

contentType

To configure all Content-Type headers allowed in the request. By default is application/x-www-form-urlencoded, _(*15)

override

To override the previous parsed body if exists (false by default), _(*16)

CsvPayload

CSV payloads are supported by the middlewares/csv-payload package., _(*17)

XmlPayload

Parses the XML payload of the request. Parsed body will return an instance of SimpleXMLElement., _(*18)

methods

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

contentType

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

override

To override the previous parsed body if exists (false by default), _(*21)

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details., _(*22)

The MIT License (MIT). Please see LICENSE for more information., _(*23)