square-bit/laravel-workflow

Add workflow support to your Laravel models.

v0.9.4 2024-09-27 13:31 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Give your models the ability to flow through multiple states.

Features:

  • default workflow per model class.
  • parallel workflows: each model can transition if more than one workflow, in parallel,
  • permissioned transitions.

Installation

You can install the package via composer:

composer require square-bit/laravel-workflow

You can publish and run the migrations with:

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

You can publish the config file with:

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

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-workflow-views"

Usage

// TODO

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.