nasyrov/laravel-interactions

Laravel package for interactions.

Laravel Interactions

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Laravel package for interactions., _(*2)

Requirements

Make sure all dependencies have been installed before moving on:, _(*3)

• PHP >= 7.0
• Composer

Install

Pull the package via Composer:, _(*4)

``` bash $ composer require nasyrov/laravel-interactions, <sub>(*5)</sub>

Register the service provider in `config/app.php`:

``` php
'providers' => [
    ...
    Nasyrov\Laravel\Interactions\InteractionServiceProvider::class,
    ...
]

Usage

Let's generate a typical user registration flow with the use of interactions., <sub>(*6)</sub>

First, generate a RegisterUser interaction via the command:, <sub>(*7)</sub>

``` bash $ php artisan make:interaction RegisterUser, <sub>(*8)</sub>

The command above will create a new file `app/Interactions/RegisterUser.php`.
Let's open the file and tailor it for our needs – create a new user:

``` php
use App\User;
use Illuminate\Http\Request;
use Nasyrov\Laravel\Interactions\Contracts\Interaction;

class RegisterUser implements Interaction
{
    /**
     * Handle the interaction.
     *
     * @return mixed
     */
    public function handle(Request $request)
    {
        return User::create([
            'name' => $request->name,
            'email' => $request->email,
            'password' => bcrypt($request->password),
        ]);
    }
}

Next, include the CallsInteractions trait into the base controller so we will be able to run the interactions in any other controller that extends the one:, <sub>(*9)</sub>

``` php use Illuminate\Foundation\Bus\DispatchesJobs; use Illuminate\Routing\Controller as BaseController; use Illuminate\Foundation\Validation\ValidatesRequests; use Illuminate\Foundation\Auth\Access\AuthorizesRequests; use Nasyrov\Laravel\Interactions\CallsInteractions;, <sub>(*10)</sub>

class Controller extends BaseController { use AuthorizesRequests, DispatchesJobs, CallsInteractions, ValidatesRequests; }, <sub>(*11)</sub>

Finally, in the `UsersController` controller run the `RegisterUser` interaction and pass the request object:

``` php
use App\Http\Controllers\Controller;
use App\Interaction\RegisterUser;
use Illuminate\Http\Request;

class UsersController extends Controller
{
    public function register(RegisterUserRequest $request)
    {
        return $this->interact(RegisterUser::class, [$request]);
    }
}

Testing

bash $ composer lint $ composer test, <sub>(*12)</sub>

Security

If you discover any security related issues, please email inasyrov@ya.ru instead of using the issue tracker., <sub>(*13)</sub>

Credits

• Evgenii Nasyrov
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*14)</sub>