Git Product home page Git Product logo

body-parser's Introduction

PHP version Latest Version License

Build Status Style Check Code Quality Code Coverage

Total Downloads Monthly Downloads

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.