middlewares / payload
Middleware to parse the body of the request with support for json, csv and url-encode
Installs: 400 912
Dependents: 17
Suggesters: 0
Security: 0
Stars: 31
Watchers: 2
Forks: 7
Open Issues: 0
Requires
- php: ^7.2 || ^8.0
- middlewares/utils: ^3.0 || ^4.0
- psr/http-server-middleware: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.0
- laminas/laminas-diactoros: ^2.3
- oscarotero/php-cs-fixer-config: ^1.0
- phpstan/phpstan: ^0.12
- phpunit/phpunit: ^8|^9
- squizlabs/php_codesniffer: ^3.0
Suggests
- middlewares/csv-payload: Adds support for parsing CSV body of request
README
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:
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.