Quickstart

Create a handler.

use Padosoft\LaravelFlow\FlowContext;
use Padosoft\LaravelFlow\FlowStepHandler;
use Padosoft\LaravelFlow\FlowStepResult;

final class ValidatePromotionInput implements FlowStepHandler
{
    public function handle(FlowContext $context): FlowStepResult
    {
        return FlowStepResult::success(output: [
            'validated' => true,
        ]);
    }
}

Create a dry-run-aware simulation handler.

final class SimulatePromotionImpact implements FlowStepHandler
{
    public function handle(FlowContext $context): FlowStepResult
    {
        return FlowStepResult::success(
            output: ['eligible_customers' => 1200],
            businessImpact: ['estimated_revenue_delta' => -4200],
        );
    }
}

Register the flow during application boot.

use Padosoft\LaravelFlow\Facades\Flow;

Flow::define('promotion.create')
    ->withInput(['brand', 'discount_pct', 'starts_at', 'ends_at'])
    ->step('validate', ValidatePromotionInput::class)
    ->step('simulate', SimulatePromotionImpact::class)
        ->withDryRun(true)
    ->step('persist', PersistPromotion::class)
        ->compensateWith(ReversePromotion::class)
    ->register();

Execute or simulate.

$preview = Flow::dryRun('promotion.create', $input);
$run = Flow::execute('promotion.create', $input);