README

A Laravel package that provides a flexible lifecycle management system for your application operations. This package helps you implement consistent patterns for handling events, transactions, logging, and authorization across your Laravel application.

Features

🛡️ Authorization Management: Control access with configurable authorization strategies
🔄 Transaction Management: Wrap operations in database transactions
📊 Logging: Automatically log actions, results, and errors
📡 Event Dispatching: Dispatch events before and after operations
🧩 Strategy Pattern: Choose which features to enable for each operation
🔌 Extensible: Create custom strategies for your specific requirements

Installation

You can install the package via composer:

composer require kwidoo/lifecycle

Configuration

Publish the configuration file:

php artisan vendor:publish --provider="Kwidoo\\Lifecycle\\LifecycleServiceProvider"

This will create a config/lifecycle.php file where you can configure default behaviors.

Usage

Basic Usage

use  Kwidoo\Lifecycle\Data\LifecycleData;

use Kwidoo\Lifecycle\Data\LifecycleOptionsData;
use Kwidoo\Lifecycle\Lifecycle\Lifecycle;

class YourService
{
    public function __construct(protected Lifecycle $lifecycle) {}

    public function performAction($context)
    {
        $data = new LifecycleData(
            action: 'create',
            resource: 'users',
            context: $context
        );

        return $this->lifecycle->run($data, function ($data) {
            // Your business logic here
            return $result;
        }, new LifecycleOptionsData());
    }
}

Customizing Options

You can customize which features are enabled:

// Disable transactions
$options = new LifecycleOptionsData();
$options = $options->withoutTrx();

// Disable events
$options = $options->withoutEvents();

// Disable logging
$options = $options->withoutLogging();

// Disable authorization
$options = $options->withoutAuth();

// Disable all features
$options = $options->withoutAll();

Lifecycle Data

The LifecycleData class encapsulates the information about an operation:

$data = new LifecycleData(
    action: 'update',      // The action being performed (create, update, delete, etc.)
    resource: 'products',  // The resource being operated on
    context: $product,     // The contextual data for the operation
);

Events

Events are dispatched with the following naming pattern:

Before operation: before.{resource}.{action}
After operation: after.{resource}.{action}
On error: error.{resource}.{action}

Advanced Usage

Custom Authorizers

You can create custom authorizers for specific resources:

namespace App\Authorizers;

use Kwidoo\Lifecycle\Authorizers\DefaultAuthorizer;

class ProductAuthorizer extends DefaultAuthorizer
{
    public function authorize(string $action, $context): bool
    {
        // Custom authorization logic
        return true;
    }
}

Custom Strategy Implementations

You can create custom strategies for events, logging, or transactions by implementing the respective interfaces:

EventableStrategy
LoggingStrategy
TransactionStrategy

Testing

composer test

The package includes comprehensive test coverage for all components including:

Unit tests for all service components
Strategy implementation tests
Feature/integration tests demonstrating real-world use cases

Tests are automatically run via GitHub Actions when code is pushed to the repository.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security issues, please email oleg@pashkovsky.me instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

kwidoo / lifecycle

Maintainers

Details