README

Based on phenomenal Loris Leiva Actions for Laravel, this package is just a wrapper with a few methods added to sugar-syntax it.

This is for version 10.x and above, which is NOT directly compatible with 1.x.

Installation

composer require frictionlessdigital/actions

Note that root namespace for the package is Fls not Frictionlessditial.

Config

The package does not require configuration.

Usage

Read base documentation here: Laravel Actions

Action::tap($value, $closure)

The protected method is similar to tap(): will return the $value after passing it to the $closure.

return $this->tap(User::first(), fn(User $user) => $user->delete());

is the equivalent of

$user = User::first();

$user->delete();

return $user;

// $user;

Action::pipe($value, $closure)

Similar to pipe(), this protected method will return the result $value after running the $closure; closure is free to modify the $value.

return $this->pipe(User::first(), fn($user) => $user->delete());

is the equivalent of

$user = User::first();

return $user->delete();

// true;

Action::validated()

This is an alias for validateAttributes() - returns an array of attributes validated through rules().

use Fls\Actions\Action;

class UserAction extends Action
{
    public function rules()
    {
        return [
            'name' => ['required', 'string'],
            'email' => ['required', 'email'],
            'notes' => ['nullable', 'string'],
        ];
    }

    ...
    public function handle($attributes) {
        return $this->fill($attributes)->validated();
    }
}

UserAction::run([
    'name' => 'John',
    'email' => 'john@smith.com',
]);

//  ['name' => 'John', 'email' => 'john@smith.com']

Action::validate()

This method will validate the attribute, throw an exception is data is not valid, but the return value is the class itself; good for chaining.

use Fls\Actions\Action;

class UserAction extends Action
{
    ...
    public function handle(User $user, $attributes) {
        return $this->fill($attributes)
                    ->validate()
                    ->tap($user, fn(User $user) => $user->update($this->validated()));
    }
}

Could be useful if you need to make sure validation is complete before chaining-in another action.

Action::runInTransaction(...$attributes)

This method will wrap the action in a DB transaction.

use Fls\Actions\Action;
use App\User;

class CreateUserAction extends Action
{
    public function handle(User $user, $attributes) 
    {
        return $user->create($attributes);
    }
}

and can be executed using run and runInTransaction alike. In the latter case, the action will be executed inside a DB::transaction. Return value would match between the two.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email support@frictionlesssolutions.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

frictionlessdigital / actions

Maintainers

Details