phpsa / laravel-case-remapping
Methods to allow the mapping of cases to snake / camel for input / output
Fund package maintenance!
phpsa
Requires
- php: ^8.0
- illuminate/contracts: ^8.41
- spatie/laravel-package-tools: ^1.4.3
Requires (Dev)
- brianium/paratest: ^6.2
- illuminate/collections: ^8.41
- nunomaduro/collision: ^5.3
- nunomaduro/larastan: ^0.7.10
- orchestra/testbench: ^6.15
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^0.12.6
- phpstan/phpstan-phpunit: ^0.12.21
- phpunit/phpunit: ^9.3
- spatie/laravel-ray: ^1.23
- vimeo/psalm: ^4.8
README
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
Installation
You can install the package via composer:
composer require phpsa/laravel-case-remapping
Usage - Middlware for incomming requests
Add as a middleware:
Phpsa\LaravelCaseRemapping\Http\Middleware\SnakeCaseInputs
to your route eg:
Route::post('xxx',[...])->withMiddleware(\Phpsa\LaravelCaseRemapping\Http\Middleware\SnakeCaseInputs::class)
in your controllers constructor:
public function __construct() { $this->middleware(\Phpsa\LaravelCaseRemapping\Http\Middleware\SnakeCaseInputs::class); }
Or globally via the app/Http.Kernal.php
file
protected $middlewareGroups = [ 'web' => [ \App\Http\Middleware\EncryptCookies::class, \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, \Illuminate\Session\Middleware\StartSession::class, // \Illuminate\Session\Middleware\AuthenticateSession::class, \Illuminate\View\Middleware\ShareErrorsFromSession::class, \App\Http\Middleware\VerifyCsrfToken::class, \Illuminate\Routing\Middleware\SubstituteBindings::class, ], 'api' => [ 'throttle:api', \Illuminate\Routing\Middleware\SubstituteBindings::class, \Phpsa\LaravelCaseRemapping\Http\Middleware\SnakeCaseInputs::class ], ];
Usage - Response wrapping for your Transformers / Response objects
add the following trait to your resource:
\Phpsa\LaravelCaseRemapping\Http\Resources\WithAcceptedCase
then in your toArray
method change to per example
public function toArray($request){
$data = parent::toArray($request);
... // any other modifications
return $this->toAcceptCase($request, $data);
}
based on the header value for X-Accept-Case-Type
passed to the request it will reaturn one of the following
camel
, kebab
, snake
Usage - Collection methods
This packages includes 3 collecion macros:
- snakeKeys - will convert all array keys to snake case
- camelKeys - will convert all array keys to camel case
- kebabKeys - will convert all array keys to kebab case
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.