Download the PHP package soap/laravel-workflow-process without Composer
On this page you can find all versions of the php package soap/laravel-workflow-process. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download soap/laravel-workflow-process
More information about soap/laravel-workflow-process
Files in soap/laravel-workflow-process
Package laravel-workflow-process
Short Description Provides Laravel workflow guards using Symfony expression and related objects
License MIT
Homepage https://github.com/soap/laravel-workflow-process
Informations about the package laravel-workflow-process
Provides Laravel workflow guards using Symfony expression and related objects
Using Zerodahero's Laravel Workflow (based on Symfony Workflow) to handle state-transition workflow is great. However, coding transition guards in events is hard. This package provides a simple way; you can add Symfony Expression Language as a transition guard for each transition. This configuration must be provided in transition metadata using the 'guard' key. The package subscribes for all workflows' transition guard events and uses the provided Symfony Expression Language to allow or block the transition.
Laravel vesion | Package version |
---|---|
10.x, 11.x, 12.x | 1.x |
Support me
Any recommendation or pull request is welcome. It is great if you sponsor me if you find my work valuable.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Usage
Task that you have to do is providing guard configuration like the following example. This is in laravel-workflow 's configuration file (config/workflow.php). If you want to store workflow configuration in database, please visit my Laravel Workflow Loader package.
Currenty these variables/objects were injected into Symfony Expression Language.
- "subject" is the Eloquent model which is subject of a workflow
- "user" is authenticated user.
- "authenticated" boolean, true if user was authenticated. You can
So you can call any method on the injected object. So you can assign guard as authenticated and subject.isPaid(), where your model has method isPaid().
Add your own guard functions
You can add your own guard function in two way. The first one is inline in configuration file. The second way is define your GuardFunction class by implement GuardFunctionInterface and point to it in the configuration. You can see example in the provided configuration file.
You can also overide the GuardEvaluator class in Application Service Provider with your own class.
Todo
I have a plan to provide document role for user. For example, some users may be assign as "reviewer" or "approver" for Eloquent model. So we can use something like subject.hasActorRole('reviewer') or subject.canBeReviewedBy(user). Any suggestion is welcome.
Testing
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
- Prasit Gebsaap
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-workflow-process with dependencies
illuminate/contracts Version ^9.0||^10.0||^11.0||^12.0
spatie/laravel-package-tools Version ^1.16
symfony/expression-language Version ^7.1
zerodahero/laravel-workflow Version ^6.1