Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tschucki/filament-workflows
Laravel Filament plugin to add workflows. Attach triggers and dispatchable actions to automate tasks
https://github.com/tschucki/filament-workflows
automation filament-plugin filamentphp laravel plugin workflows
Last synced: 23 days ago
JSON representation
Laravel Filament plugin to add workflows. Attach triggers and dispatchable actions to automate tasks
- Host: GitHub
- URL: https://github.com/tschucki/filament-workflows
- Owner: Tschucki
- License: mit
- Created: 2024-01-27T22:37:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T19:35:09.000Z (4 months ago)
- Last Synced: 2024-11-24T20:54:40.679Z (2 months ago)
- Topics: automation, filament-plugin, filamentphp, laravel, plugin, workflows
- Language: PHP
- Homepage:
- Size: 188 KB
- Stars: 12
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Add workflows to your filament app
[](https://packagist.org/packages/tschucki/filament-workflows)
[](https://github.com/tschucki/filament-workflows/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/Tschucki/filament-workflows/actions/workflows/fix-php-code-styling.yml)
[](https://packagist.org/packages/tschucki/filament-workflows)
This plugin lets you add workflows to your filament app. You can attach triggers and dispatchable actions to your
workflows. The plugin will automatically execute the actions when the trigger conditions are met.
## Table of Contents
- [Images](#images)
- [Installation](#installation)
- [Usage](#usage)
- [Basics](#basics)
- [Add the trait to your model](#add-the-trait-to-your-model)
- [Create an Action](#create-an-action)
- [Configuration](#configuration)
- [Define searchable field](#define-searchable-field)
- [Max Search Results](#max-search-results)
- [Testing](#testing)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Credits](#credits)
- [License](#license)
## Images
## Installation
You can install the package via composer:
```bash
composer require tschucki/filament-workflows
```
You can install the plugin using:
```bash
php artisan filament-workflows:install
```
You can publish and run the migrations manually with:
```bash
php artisan vendor:publish --tag="filament-workflows-migrations"
php artisan migrate
```
Register the plugin in your `AdminPanelServiceProvider`:
```php
use Tschucki\FilamentWorkflows\FilamentWorkflowsPlugin;
->plugins([
FilamentWorkflowsPlugin::make()
])
```
## Usage
### Basics
In order to let your models use workflows, you need to add the `InteractsWithWorkflows` trait to your model. By adding this trait, the plugin will automatically add a global observer to your model. So when ever a workflow matches the event and trigger conditions, the workflow will execute the actions.
### Add the trait to your model
```php
use Tschucki\FilamentWorkflows\Concerns\InteractsWithWorkflow;
class User extends Model {
use InteractsWithWorkflow;
}
```
### Create an Action
In order to attach an action to your workflows, you will have to create a class within the `App\Jobs\Actions` folder. The class must extend the `BaseAction` class. This requires you to implement the `handle` method. This method will be called when the workflow is executed.
The action class is very similar to a job.
When ever the action get executed, the model will be passed to the `__construct` method. You can use the model to do whatever you want.
The plugin will find this class on its own. So you don't have to register it anywhere.
```php
user = $user;
}
public function handle(): void
{
\Log::info($this->user->name . ' was created at ' . $this->user->created_at);
}
// Will be later used in the Logs (coming soon)
public function getActionName(): string
{
return 'Der Hackfleisch hassender Zerhacker';
}
public function getActionDescription(): string
{
return 'Schneidet Kopfsalat. Und das nachts :)';
}
public function getActionCategory(): string
{
return 'Default-Category';
}
public function getActionIcon(): string
{
return 'heroicon-o-adjustments';
}
}
```
That's it. Now you can create and attach actions to your workflows.
## Configuration
### Define searchable field
If you don't just want to search for the `id`, you can use the function `getTitleColumnForWorkflowSearch` within your model to search in another field as well.
```php
public function getTitleColumnForWorkflowSearch(): ?string
{
return 'name';
}
```
### Max Search Results
In case you want to change the max search results for the models, you can publish the config file and change the `workflows.search.max_results` value (defaults to 100).
This can come in handy when you have a lot of models and the search is slow.
```php
[
'max_results' => 100,
]
];
```
### Use Custom Models and Resources
If you want to use custom models and resources, you can publish the config file and change the `workflows.models` and `workflows.resources` values. It is highly recommended that custom models and resources extend the existing Workflow classes.
```php
[
'workflow' => \Tschucki\FilamentWorkflows\Models\WorkflowLog::class,
'workflow_log' => \Tschucki\FilamentWorkflows\Models\WorkflowLog::class,
],
'resources' => [
'workflow' => \Tschucki\FilamentWorkflows\Resources\FilamentWorkflowResource::class,
],
];
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Marcel Wagner](https://github.com/Tschucki)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.