hivokas/laravel-handlers

Request handlers for Laravel

Sunday, July 29, 2018
by hivokas
Repository
2 Watchers
65 Stars
40 Installations

PHP
0 Dependents
0 Suggesters
1 Forks
1 Open issues
6 Versions
0 % Grown

The README.md

Laravel Handlers

, _(*1)

Goodbye controllers, hello request handlers!, _(*2)

This package adds a handy way of creating the request handlers., _(*3)

Basically, the request handler is a single action controller which leads to a more clear request to the response flow., _(*4)

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., _(*5)

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:, _(*6)

composer require hivokas/laravel-handlers

The package will automatically register itself., _(*7)

You can publish the config file with:, _(*8)

php artisan vendor:publish --provider="Hivokas\LaravelHandlers\Providers\HandlersServiceProvider" --tag="config"

This is the contents of the published config file:, _(*9)

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

Showcase , _(*10)

Create a handler

php artisan make:handler ShowPost

ShowPost handler will be created, _(*11)

Create handlers for all resource actions (index, show, create, store, edit, update, destroy)

php artisan make:handler Post --resource

IndexPost, ShowPost, CreatePost, StorePost, EditPost, UpdatePost, DestroyPost handlers will be created, _(*12)

Exclude unnecessary for an API actions (create, edit)

php artisan make:handler Post --resource --api

IndexPost, ShowPost, StorePost, UpdatePost, DestroyPost handlers will be created, _(*13)

Create handlers by the specified actions

php artisan make:handler Post --actions=show,destroy,approve

ShowPost, DestroyPost, ApprovePost handlers will be created, _(*14)

Exclude specified actions

php artisan make:handler Post --resource --except=index,show,edit

CreatePost, StorePost, UpdatePost, DestroyPost handlers will be created, _(*15)

Specify namespace for handlers creating (relative path)

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, _(*16)

Specify namespace for handlers creating (absolute path)

php artisan make:handler ActivateUser --namespace=\\App\\Foo\\Bar

ActivateUser handler will be created under App\Foo\Bar namespace in app/Foo/Bar directory, _(*17)

Force create

php artisan make:handler EditPost --force

If EditPost handler already exists, it will be overwritten by the new one, _(*18)

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., _(*19)

Eventually your handlers will look something like this:, _(*20)

<?php

namespace App\Http\Handlers\Foo;

use App\Models\Foo;
use App\Services\FooService;
use Hivokas\LaravelHandlers\Handler;
use App\Http\Requests\Foo\UpdateFooRequest;

class UpdateFoo extends Handler
{
    protected $service;

    public function __construct(FooService $service)
    {
        $this->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., _(*21)

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

// app/Providers/RouteServiceProvider.php

protected function mapHandlersRoutes()
{
    Route::middleware('web')
         ->namespace('App\Http\Handlers')
         ->group(base_path('routes/handlers.php'));
}

// app/Providers/RouteServiceProvider.php

public function map()
{
    $this->mapApiRoutes();

    $this->mapWebRoutes();

    $this->mapHandlersRoutes();

    //
}

// routes/handlers.php

Route::get('/post/{post}', 'ShowPost');

Without namespace auto prefixing

// app/Providers/RouteServiceProvider.php

protected function mapHandlersRoutes()
{
    Route::middleware('web')
         ->group(base_path('routes/handlers.php'));
}

// app/Providers/RouteServiceProvider.php

public function map()
{
    $this->mapApiRoutes();

    $this->mapWebRoutes();

    $this->mapHandlersRoutes();

    //
}

// 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

// 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

// 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');
});