Download the PHP package monzer/filament-workflows without Composer

🚀 Filament Workflows Plugin for Laravel

✨ Introduction

This package is a FilamentPHP plugin designed to provide a workflow automation system within FilamentPHP applications. It enables users to create and manage workflows triggered by model events, custom events, or scheduled tasks. The package integrates seamlessly with FilamentPHP, offering a Filament Resource for managing workflows.

🌟 Features

• 🔄 Workflow automation via model events, custom events, or scheduling.
• 🛠️ Filament Resource for CRUD workflow management.
• 🏗️ Supports custom workflow actions.
• 📜 Execution logs viewable through Filament.
• 🔗 Chaining of multiple actions.
• 🌍 Webhook sending as an external integration.
• ✨ Magic Attributes enable dynamic replacement of placeholders with model attributes or event data, allowing seamless data binding and automation within the system.

Screenshots

⚙️ Installation & Setup

🖥️ Requirements

Ensure your Laravel application meets the following requirements:

• Laravel 10+
• FilamentPHP 3.2
• PHP 8.1+

📥 Install the Package

⚡ Publish Migration

⚡ Publish Configuration (Optional)

📊 Migrate Database

🔧 Registering the Plugin

Users must manually register the plugin in their PanelProvider.php:

📌 Setting Up Model Event Workflows

To integrate a model with the model event workflow system, the model must implement the following trait:

To change the model display name you can use the getModelName() static function:

To change the attributes display name you can use the getAttributeName() static function:

NOTE:

You need to run php artisan schedule:work command to run the workflows.

🔧 Configuration

Example configuration in config/workflows.php:

📝 Log Management

Automatic Log Rotation

Starting from version 0.3.0, this package includes automatic log rotation to prevent database overflow. By default, only the last 100 log entries are kept for each workflow.

Configuration

You can customize the maximum number of log entries by setting the WORKFLOWS_MAX_LOG_ENTRIES environment variable:

Or modify it directly in the config file:

To disable log rotation (not recommended):

Cleaning Up Existing Logs

If you have existing workflows with large log histories, you can clean them up using the provided artisan command:

Database Migration for Large Logs

For existing installations that experience database errors due to large logs, run the optional migration to increase column size:

🪄 Magic Attributes

Magic attributes are placeholders that get dynamically replaced with actual data from the model or event triggering the workflow.

🔄 Model Event Workflows

• @email@ → Replaced by the model's email attribute.

  • Example:

  • If the model contains email = [email protected], the message will be:

🎭 Custom Event Workflows

• @event->name@ → Replaced by the event’s name attribute.

  • Example:

  • If the event contains name = System Update, the message will be:

🎯 Defining Custom Workflow Actions

Users can create custom actions by implementing the Action interface. Below is an example implementation of the SendEmail** action:

Then add your custom action

🔗 Sharing Data Between Actions

To allow actions to be aware of each other and share data, a shared data array is passed between actions in the execute function. This enables actions to store and retrieve information dynamically as they execute.

📌 How It Works:

• Each action receives a shared data array.
• Actions can store values inside this array to be used by subsequent actions.
• The shared data persists throughout the workflow execution.

📝 Example: Sharing Data Between Actions

Let's say we need to:

1️⃣ Generate an Invoice and store the invoice_id. 2️⃣ Send an Email using that invoice_id.

🛠️ Action 1: Generate Invoice

📧 Action 2: Send Email with Invoice ID

Using workflows with tenancy

Create a middleware to setup tenancy

Then, add the middleware to the panel

🧪 Tests

Currently, automated tests are not available for this package. Future updates may include unit tests and integration tests to ensure workflow stability and execution accuracy.

❤️ Support & Contributions

For issues and feature requests, please visit the GitHub repository and create an issue.

Pull requests are welcome. Make sure to follow the contribution guidelines.

💰 Support the Project

If you find this package helpful and would like to support its development, consider making a donation:

☕ Buy Me a Coffee

Your support helps improve and maintain this package! 🙌

📜 License

This package is licensed under the MIT License. See the LICENSE file for details.