Queueable actions in Laravel

Actions are a way of structuring your business logic in Laravel. This package adds easy support to make them queueable.

$myAction->onQueue()->execute();

You can specify a queue name.

$myAction->onQueue('my-favorite-queue')->execute();

Support us

Learn how to create a package like this one, by watching our premium video course:

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/laravel-queueable-action

Usage

If you want to know about the reasoning behind actions and their asynchronous usage, you should read the dedicated blog post: https://stitcher.io/blog/laravel-queueable-actions.

You can use the following Artisan command to generate queueable and synchronous action classes on the fly.

php artisan make:action MyAction [--sync]

Here's an example of queueable actions in use:

class MyAction
{
    use QueueableAction;

    public function __construct(
        OtherAction $otherAction,
        ServiceFromTheContainer $service
    ) {
        // Constructor arguments can come from the container.
    
        $this->otherAction = $otherAction;
        $this->service = $service;
    }

    public function execute(
        MyModel $model,
        RequestData $requestData
    ) {
        // The business logic goes here, this can be executed in an async job.
    }
}

class MyController
{
    public function store(
        MyRequest $request,
        MyModel $model,
        MyAction $action
    ) {
        $requestData = RequestData::fromRequest($myRequest);
        
        // Execute the action on the queue:
        $action->onQueue()->execute($model, $requestData);
        
        // Or right now:
        $action->execute($model, $requestData);
    }
}

Chaining actions

You can chain actions by wrapping them in the ActionJob.

Here's an example of two actions with the same arguments:

use Spatie\QueueableAction\ActionJob;

$args = [$userId, $data];

app(MyAction::class)
    ->onQueue()
    ->execute(...$args)
    ->chain([
        new ActionJob(AnotherAction::class, $args),
    ]);

The ActionJob takes the action class or instance as the first argument followed by an array of the action's own arguments.

Custom Tags

If you want to change what tags show up in Horizon for your custom actions you can override the tags() function.

class CustomTagsAction
{
    use QueueableAction;

    // ...

    public function tags() {
        return ['action', 'custom_tags'];
    }
}

What is the difference between actions and jobs?

In short: constructor injection allows for much more flexibility. You can read an in-depth explanation here: https://stitcher.io/blog/laravel-queueable-actions.

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

• Brent Roose
• Alex Vanderbist
• Sebastian De Deyne
• Freek Van der Herten
• All Contributors

License

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