middlewares / method-override
Middleware to override the request method using the X-Http-Method-Override header
Installs: 15 962
Dependents: 1
Suggesters: 0
Security: 0
Stars: 6
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: ^7.2 || ^8.0
- middlewares/utils: ^3.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
README
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
- PHP >= 7.2
- A PSR-7 http library
- A PSR-15 middleware dispatcher
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.