Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hivokas/laravel-handlers
Request handlers for Laravel
https://github.com/hivokas/laravel-handlers
action controller handler handlers laravel single
Last synced: 25 days ago
JSON representation
Request handlers for Laravel
- Host: GitHub
- URL: https://github.com/hivokas/laravel-handlers
- Owner: hivokas
- License: mit
- Created: 2018-07-19T22:55:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-29T21:37:14.000Z (about 5 years ago)
- Last Synced: 2024-09-30T23:40:55.059Z (about 1 month ago)
- Topics: action, controller, handler, handlers, laravel, single
- Language: PHP
- Homepage: https://laravel-news.com/laravel-handlers
- Size: 66.4 KB
- Stars: 129
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Handlers
[](https://github.com/hivokas/laravel-handlers/releases)
[](LICENSE.md)
[](https://travis-ci.org/hivokas/laravel-handlers)
[](https://styleci.io/repos/141638370)
[](https://scrutinizer-ci.com/g/hivokas/laravel-handlers)
[](https://scrutinizer-ci.com/g/hivokas/laravel-handlers/code-structure)
> Goodbye controllers, hello request handlers!
This package adds a handy way of creating the request handlers.
Basically, the request handler is a single action controller which leads to a more clear request to the response flow.
You should try to use request handlers instead of with controllers and you probably won't feel the need to go back to controllers anytime soon.
## Some advantages in comparison with controllers
- single responsibility (seems like controllers with many actions break this principle);
- testability (you won't need to resolve dependencies that are not related to the action you are testing, since there is only single action in each request handler);
- registering of routes (`Route::get('/posts/{post}', ShowPost::class)` is much more convenient and pretty than `Route::get('/posts/{post}', 'PostController@show')`).
## Installation
You can install this package via composer using this command:
```bash
composer require hivokas/laravel-handlers
```
The package will automatically register itself.
You can publish the config file with:
```bash
php artisan vendor:publish --provider="Hivokas\LaravelHandlers\Providers\HandlersServiceProvider" --tag="config"
```
This is the contents of the published config file:
```php
return [
/*
|--------------------------------------------------------------------------
| Base Handler Class
|--------------------------------------------------------------------------
|
| Here you may specify which class will be used as the base class
| for all generated handlers.
|
*/
'base' => Hivokas\LaravelHandlers\Handler::class,
];
```
## Creation of request handlers
- Create a handler
```bash
php artisan make:handler ShowPost
```
> `ShowPost` handler will be created
- Create handlers for all resource actions (`index`, `show`, `create`, `store`, `edit`, `update`, `destroy`)
```bash
php artisan make:handler Post --resource
```
> `IndexPost`, `ShowPost`, `CreatePost`, `StorePost`, `EditPost`, `UpdatePost`, `DestroyPost` handlers will be created
- Exclude unnecessary for an API actions (`create`, `edit`)
```bash
php artisan make:handler Post --resource --api
```
> `IndexPost`, `ShowPost`, `StorePost`, `UpdatePost`, `DestroyPost` handlers will be created
- Create handlers by the specified actions
```bash
php artisan make:handler Post --actions=show,destroy,approve
```
> `ShowPost`, `DestroyPost`, `ApprovePost` handlers will be created
- Exclude specified actions
```bash
php artisan make:handler Post --resource --except=index,show,edit
```
> `CreatePost`, `StorePost`, `UpdatePost`, `DestroyPost` handlers will be created
- Specify namespace for handlers creating (relative path)
```bash
php artisan make:handler Post --resource --namespace=Post
```
> `IndexPost`, `ShowPost`, `CreatePost`, `StorePost`, `EditPost`, `UpdatePost`, `DestroyPost` handlers will be created under `App\Http\Handlers\Post` namespace in `app/Http/Handlers/Post` directory
- Specify namespace for handlers creating (absolute path)
```bash
php artisan make:handler ActivateUser --namespace=\\App\\Foo\\Bar
```
> `ActivateUser` handler will be created under `App\Foo\Bar` namespace in `app/Foo/Bar` directory
- Force create
```bash
php artisan make:handler EditPost --force
```
> If `EditPost` handler already exists, it will be overwritten by the new one
## Writing logic in request handler
Request handlers are invokable classes that use PHP's `__invoke` magic function, turning them into a Callable, which allows them to be called as a function. So you need to return response in `__invoke` method.
Eventually your handlers will look something like this:
```php
service = $service;
}
public function __invoke(UpdateFooRequest $request, Foo $foo)
{
$this->bar($foo, $request->validated());
return redirect('foo.show', $foo);
}
protected function bar(Foo $foo, array $validated)
{
return $this->service->baz($foo, $validated);
}
}
```
## Registering of routes
Here are several ways to register routes where request handlers are used as an actions.
#### In separate `handlers.php` route file
- Create `routes/handlers.php` file (you can choose any name, it's just an example)
- Define the "handlers" route group in `app/Providers/RouteServiceProvider.php`
> ##### With namespace auto prefixing
```php
// app/Providers/RouteServiceProvider.php
protected function mapHandlersRoutes()
{
Route::middleware('web')
->namespace('App\Http\Handlers')
->group(base_path('routes/handlers.php'));
}
```
```php
// app/Providers/RouteServiceProvider.php
public function map()
{
$this->mapApiRoutes();
$this->mapWebRoutes();
$this->mapHandlersRoutes();
//
}
```
```php
// routes/handlers.php
Route::get('/post/{post}', 'ShowPost');
```
> ##### Without namespace auto prefixing
```php
// app/Providers/RouteServiceProvider.php
protected function mapHandlersRoutes()
{
Route::middleware('web')
->group(base_path('routes/handlers.php'));
}
```
```php
// app/Providers/RouteServiceProvider.php
public function map()
{
$this->mapApiRoutes();
$this->mapWebRoutes();
$this->mapHandlersRoutes();
//
}
```
```php
// routes/handlers.php
use App\Handlers\ShowPost;
Route::get('/post/{post}', ShowPost::class); // pretty sweet, isn't it? 😍
```
#### In `web.php` route file
- Change the namespace for "web" group in `RouteServiceProvider.php`
```php
// app/Providers/RouteServiceProvider.php
protected function mapWebRoutes()
{
Route::middleware('web')
->namespace('App\Http') // pay attention here
->group(base_path('routes/web.php'));
}
```
- Put request handlers and controllers in different route groups in `routes/web.php` file and prepend an appropriate namespace for each of them
```php
// routes/web.php
Route::group(['namespace' => 'Handlers'], function () {
Route::get('/posts/{post}', 'ShowPost');
Route::delete('/posts/{post}', 'DestroyPost');
});
Route::group(['namespace' => 'Controllers'], function () {
Route::get('/users', 'UserController@index');
Route::get('/users/{user}', 'UserController@show');
});
```
## Testing
You can run the tests with:
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.