middlewares/method-override

Middleware to override the request method using the X-Http-Method-Override header

v2.0.0 2019-11-30 16:10 UTC

This package is auto-updated.

Last update: 2020-04-30 00:42:10 UTC


README

Latest Version on Packagist Software License Build Status Quality Score Total Downloads

Middleware to override the request method using the X-Http-Method-Override header. This is useful for clients unable to send other methods than GET and POST.

Requirements

Installation

This package is installable and autoloadable via Composer as middlewares/method-override.

composer require middlewares/method-override

Example

Dispatcher::run([
    (new Middlewares\MethodOverride())
        ->getMethods(['HEAD', 'CONNECT', 'TRACE', 'OPTIONS'])
        ->postMethods(['PATCH', 'PUT', 'DELETE', 'COPY', 'LOCK', 'UNLOCK'])
        ->queryParameter('method')
        ->parsedBodyParameter('method')
]);

Usage

In the constructor you can provide a Psr\Http\Message\ResponseFactoryInterface to create the error response (405). If it's not defined, Middleware\Utils\Factory will be used to detect it automatically.

$responseFactory = new MyOwnResponseFactory();

$override = new Middlewares\MethodOverride($responseFactory);

getMethods

Allows to define the methods that can override the GET method. By default is ['HEAD', 'CONNECT', 'TRACE', 'OPTIONS'].

//The GET method can be overrided only with HEAD and CONNECT
$override = (new Middlewares\MethodOverride())->getMethods(['HEAD', 'CONNECT']);

postMethods

Array with the methods that can override the POST method. By default is ['PATCH', 'PUT', 'DELETE', 'COPY', 'LOCK', 'UNLOCK'].

//The POST method can be overrided only with DELETE and PUT 
$override = (new Middlewares\MethodOverride())->getMethods(['DELETE', 'PUT']);

queryParameter

Allows to use a query parameter in addition to the X-Http-Method-Override in GET requests. For example http://example.com/view/23?method=HEAD

//The method can be override with ?new_method=OPTIONS
$override = (new Middlewares\MethodOverride())->queryParameter('new_method');

parsedBodyParameter

Allows to use a parsed body parameter in addition to the X-Http-Method-Override in POST.

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.