spatie/laravel-queueable-action

Queueable action support in Laravel

1.0.0 2019-02-28 08:06 UTC

README

Latest Version on Packagist StyleCI Build Status Quality Score Total Downloads

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

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

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.

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);
    }
}

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 freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

License

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