Download the PHP package jakubciszak/rule-engine without Composer
On this page you can find all versions of the php package jakubciszak/rule-engine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rule-engine
Rule Engine
Rule Engine lets you express business logic in plain PHP arrays and evaluate it with ease. Pick the API that matches the shape of your data:
- FlatRuleAPI – send a linear array in Reverse Polish Notation for fast stack-based evaluation.
- NestedRuleApi – describe rules as nested associative arrays that read like infix notation.
- StringRuleApi – parse and evaluate human readable infix expressions.
Both APIs accept arrays decoded from JSON and can work with callables inside the evaluation context, giving you a flexible way to run rules or trigger simple actions.
How it works
The library implements the Rule Archetype Pattern from the book "Enterprise Patterns and MDA: Building Better Software with Archetype Patterns and UML" by Jim Arlow and Ila Neustadt. Rules are composed of propositions, operators and optional actions. Depending on whether you use FlatRuleAPI or NestedRuleApi, the rule is converted to a uniform internal structure that the engine evaluates against the provided context.
Requirements
- PHP 8.4 or higher
- Composer
Installation
To install the library, use Composer:
`
Usage
FlatRuleAPI
Rules can also be defined using JSON in RPN order. The example below presents two rules:
This JSON can be decoded and passed to the FlatRuleAPI context to get the evaluation result as a boolean. The context array is
passed by reference and updated with any values changed during evaluation.
NestedRuleApi
NestedRuleApi accepts rules defined using a JSON structure that resembles infix notation. Operators are written as keys and their arguments are provided in nested arrays.
You can also pass a set of named rules for evaluation:
StringRuleApi usage
StringRuleApi accepts conditions written as human readable infix expressions. Variables are denoted by a leading dot and resolved from the supplied data array.
Complex nested conditions are also supported:
StringRuleApi can evaluate a set of named expressions as a ruleset, returning a single boolean result:
Boolean variables can be referenced directly without explicit comparison and negated using not:
Rule actions
Each rule may include simple actions executed when the rule is evaluated. Actions are expressed as strings:
Supported operators are + (addition), - (subtraction), . (concatenation) and = (assignment). Values starting with . reference variables from the evaluation context.
When using NestedRuleApi, specify actions under the actions key alongside the rule expression or within each rule of a ruleset.
FlatRuleAPI example
Evaluating the JSON above with { "a": 1, "b": 1, "count": 0 } updates count to 1 when the rule evaluates to true.
NestedRuleApi example
What is behind?
Pure PHP library usage gives most flexible and powerful solutions
Notation
This implementation use Reverse Polish Notation (RPN). \ RPN is a mathematical notation in which operators follow their operands. This notation eliminates the need for parentheses that are used in standard infix notation, making the evaluation of expressions simpler and more efficient.
For example, the expression \
(2 + 3) * 5 \
in standard notation would be written as \
2 3 + 5 * in RPN.
In this notation, you first add 2 and 3 to get 5, and then multiply by 5 to get 25.
The Rule Engine uses RPN to simplify the process of building conditions, making it more intuitive to construct complex logical expressions.
Creating Rules
You can create rules using the provided methods for different operators:
Evaluating Rules
To evaluate a rule, you need to provide a RuleContext:
Development
Running Tests
To run the tests, use PHPUnit:
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License.
Authors
- Jakub Ciszak - [email protected]
Additional Information
- The project uses the
munusphp/munuslibrary for functional programming constructs. - The source code is located in the
src/directory. - Tests are located in the
tests/directory.
