README

Provides tools for rules engine pattern

Installation

Install this package as a dependency using Composer.

composer require easyblue/rules-engine

Usage

In PHP app

You can create an instance of rule engine with passing processor.

use Easyblue\RulesEngine\Core\RulesEngine;
use Acme\RulesEngine\Profile;

$profilesRuleEngine = new RulesEngine(
    'profiles',
    ['chained' => true],
    [
        new Profile\FreemiumProcessor(),
        new Profile\PremiumProcessor(),
        new Profile\GoldProcessor(),
        new Profile\AdminProcessor(),
    ]
);

$profilesRuleEngine->process($user);

In Symfony app

First, register the bundle in config/bundles.php

<?php

return [
    // ...
    \Easyblue\RulesEngine\Symfony\RulesEngineBundle::class => ['all' => true],
];

You can configure engines in config/packages/rules_engine.{yaml|php|...}

rules_engine:
    engines:
        profile:
            chained: true

The key profile is the name of the engine that will process on each rules_engine.profile.processor tagged service. You simply can implements Easyblue\RulesEngine\Core\ProcessorInterface and use AsProcessor attribute like this :

use Easyblue\RulesEngine\Core\ProcessorInterface;
use Easyblue\RulesEngine\Symfony\Attribute\AsProcessor;

#[AsProcessor('profile', 10)]
class ProfileProcessor implements ProcessorInterface {
    // ...
}

An instance of Easyblue\RulesEngine\Core\RulesEngine is available in the container, so you can inject it in your services.

use Easyblue\RulesEngine\Core\RulesEngine;

final class ProfileController {
    public function __construct(private readonly RulesEngine $profileRulesEngine)
    {
    }
}

List all engines configured with bin/console debug:autowiring rules_engine

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

easyblue / rules-engine

Maintainers

Details