michielkempen/laravel-actions

6.0.0 2021-08-03 18:49 UTC

Requires

• php: ^8.0
• ext-json: *
• laravel/framework: ^7.31|^8.40
• michielkempen/laravel-enum: ^1.0
• michielkempen/laravel-uuid-model: ^3.0
• spatie/async: ^1.5

Requires (Dev)

• orchestra/testbench: ^6.0

MIT

• Michiel Kempen

• michielkempen
• laravel-actions

README

This package was inspired by Spatie's Laravel Queueable Action package.

As mentioned in the documentation of Spatie's package, actions are a way of structuring your business logic in Laravel. A detailed blogpost discussing the reasoning behind actions and their asynchronous usage can be found via this link.

This package builds on top of the idea of asynchronous actions, and adds a mechanism to track the state of queued actions in real-time.

Installation

Add the package to the dependencies of your application

composer require michielkempen/laravel-actions

The package will automatically register itself.

You can publish the migration with:

php artisan vendor:publish --provider="MichielKempen\LaravelActions\ActionsServiceProvider" --tag="migrations"

After the migration has been published you can create the queued_action_chains and queued_actions database tables by running:

php artisan migrate

Usage

Synchronous action chain execution:

$uuid = (string) Uuid::generate(4);

(new QueueableActionChain)
    ->addAction(ReturnTheFirstParameterAsOutputAction::class, ['hello', 'world'], "Greetings!", $uuid)
    ->addAction(ReturnTheParametersAsOutputAction::class, ['john', 'doe'])
    ->addAction(ReturnTheParametersAsOutputAction::class, [new ActionOutput($uuid), 'joe'], "Test action output")
    ->withCallback(ReturnStatusCallback::class)
    ->execute();

Asynchronous action chain execution:

$uuid = (string) Uuid::generate(4);
$model = TestModel::create();

(new QueueableActionChain)
    ->queue()
    ->onModel($model)
    ->withName("Test action")
    ->addAction(ReturnTheFirstParameterAsOutputAction::class, ['hello', 'world'], "Greetings!", $uuid)
    ->addAction(ReturnTheParametersAsOutputAction::class, ['john', 'doe'])
    ->addAction(ReturnTheParametersAsOutputAction::class, [new ActionOutput($uuid), 'joe'], "Test action output")
    ->withCallback(ReturnStatusCallback::class)
    ->execute();

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Michiel Kempen
• All Contributors

License

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