README

A minimal package for using the actions pattern in Laravel.

Installation

You can install the package via composer:

composer require returnearly/actions-pattern

Action Class

<?php

declare(strict_types=1);

namespace App\Actions;

final readonly class MyCustomAction
{
    public function __construct(
        private MyDependency $dependency
    ) {
    }

    public function handle(int $amount): void
    {
        $amount += 10;
    
        $this->dependency->doSomething($amount);
    }
}

Usage

\App\Actions\MyCustomAction::make()->handle($item)

or via dependency injection

use App\Actions\MyCustomAction;

class MyController
{
    public function __construct(
        private MyCustomAction $action
    ){
    }

    public function __invoke($item)
    {
        $this->action->handle($item);
    }
}

Create An Action

php artisan make:action MyCustomAction --test

Running the above command will create a new action class in the app/Actions directory and the corresponding test in the tests/Feature/Actions directory.

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.

returnearly / actions-pattern

Maintainers

Details