Parse encoded request body data.
Enables JSON and XML request payloads to be parsed into the request's Provides CSRF protection & validation.
You can also add your own request body parsers using the addParser()
method.
$methods
protected array
$parsers
protected array
__construct( array $options [] )
Constructor
json
Set to false to disable json body parsing.xml
Set to true to enable XML parsing. Defaults to false, as XML handling requires more care than JSON does.methods
The HTTP methods to parse on. Defaults to PUT, POST, PATCH DELETE.$options
optional [] __invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )
Apply the middleware.
Will modify the request adding a parsed body if the content-type is known.
$request
$response
$next
Cake\Http\Response
addParser( array $types , callable $parser )
Add a parser.
Map a set of content-type header values to be parsed by the $parser.
An naive CSV request body parser could be built like so:
$parser->addParser(['text/csv'], function ($body) { return str_getcsv($body); });
$types
$parser
The parser function. Must return an array of data to be inserted into the request.
decodeJson( string $body )
Decode JSON into an array.
$body
decodeXml( string $body )
Decode XML into an array.
$body
setMethods( array $methods )
Set the HTTP methods to parse request bodies on.
$methods
protected array
The HTTP methods to parse data on.
['PUT', 'POST', 'PATCH', 'DELETE']
© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Http.Middleware.BodyParserMiddleware.html