README

Installation

You can install the package via composer:

composer require elegantly/laravel-workflow

You can publish and run the migrations with:

php artisan vendor:publish --tag="workflow-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="workflow-config"

This is the contents of the published config file:

return [

    'queue' => env('WORKFLOW_QUEUE'),

    'queue_connection' => env('WORKFLOW_QUEUE_CONNECTION'),

];

Usage

Defining your workflows

Define a workflow in a class like this one:

namespace App\Workflows;

use Carbon\CarbonInterval;
use Elegantly\Workflow\Models\Workflow;
use Elegantly\Workflow\WorkflowDefinition;
use Elegantly\Workflow\WorkflowStep;
use Illuminate\Support\Collection;

class WelcomeUserWorkflow extends WorkflowDefinition
{
    public function __construct(
        public User $user
    ) {
        //
    }

    public function steps(Workflow $workflow): Collection
    {
        return collect()
            ->put(
                'welcome-email',
                WorkflowStep::make($workflow)
                    ->action(function (): void {
                        // send an email to the user
                    })
            )
            ->put(
                'export-user',
                WorkflowStep::make($workflow)
                    ->action(new ExportUserToCrmJob($this->user))
            )
            ->put(
                'product-tour-email',
                WorkflowStep::make($workflow)
                    ->after([
                        'welcome-email' => CarbonInterval::days(3)
                    ])
                    ->action(function (): void {
                        // Send another email to your user
                    })
            )
            ->put(
                'send-promo-code',
                WorkflowStep::make($workflow)
                    ->after([
                        'product-tour-email' => CarbonInterval::days(7),
                    ])
                    ->when(fn() => $this->user->hasNotPurchased())
                    ->action(function (): void {
                        //
                    })
            );
    }
}

Running your workflow

use Elegantly\Workflow\Commands\RunWorkflowsCommand;

$schedule->command(RunWorkflowsCommand::class)->everyMinutes();

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.

elegantly / laravel-workflow

Maintainers

Details