juliangut / body-parser
PSR7 body parser middleware
Installs: 9 266
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 1
Requires
- php: >=5.6
- psr/http-message: ^1.0
- willdurand/negotiation: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^1.0
- humbug/humbug: ~1.0@dev
- league/csv: ^8.0
- phpmd/phpmd: ^2.0
- phpunit/phpunit: ^4.5|^5.0
- sebastian/phpcpd: ^2.0
- squizlabs/php_codesniffer: ^2.0
- zendframework/zend-diactoros: ^1.0
Suggests
- league/csv: Used by CSV decoder
This package is auto-updated.
Last update: 2024-11-24 21:46:12 UTC
README
body-parser
PSR7 request body parser middleware.
PSR7 implementations doesn't normally parse request body to be available through $request->getParsedBody()
or they only do it for certain request methods or content types.
The best way to be fully confident that your request content will be parsed correctly while using the PSR7 implementation that you want is through the use of a middleware responsible of this task.
Installation
Composer
composer require juliangut/body-parser
Usage
Add as many content decoders as you want to cover your application needs based on request's Content-Type
header.
Decoders are assign to one or more HTTP methods.
Integrate in your middleware aware application workflow.
require './vendor/autoload.php'; use Jgut\BodyParser\Decoder\Json; use Jgut\BodyParser\Decoder\Urlencoded; use Jgut\BodyParser\Parser; use Negotiator\Negtiator; $bodyParser = new Parser(new Negotiator()); $bodyParser->addDecoder(new Urlencoded()); // Assigned to all requests $bodyParser->addDecoder(new Json(), ['POST', 'PUT']); // Assigned only to POST and PUT requests $app = new \YourMiddlewareAwareApplication(); $app->addMiddleware($bodyParser); $app->run();
Review the documentation of the PSR7 implementation you use as it may already parse request body in some cases. You don't want to do the same job twice.
Decoders
URL encoded
$decoder = new \Jgut\BodyParser\Decoder\UrlEncoded();
Supported MIME types:
- application/x-www-form-urlencoded
JSON
$decoder = new \Jgut\BodyParser\Decoder\Json();
Supported MIME types:
- application/json
- text/json
- application/x-json
XML
$decoder = new \Jgut\BodyParser\Decoder\Xml();
Supported MIME types:
- application/xml
- text/xml
- application/x-xml
CSV
$decoder = new \Jgut\BodyParser\Decoder\Csv($delimiter = ',', $enclosure = '"', $escape = '\\');
Supported MIME types:
- text/csv
Custom
You can create your own decoder implementing Jgut\BodyParser\Decoder\Decoder
interface.
For example you could implement a YAML decoder for application/x-yaml
and text/yaml
MIME types.
Contributing
Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before.
See file CONTRIBUTING.md
License
See file LICENSE included with the source code for a copy of the license terms.