Download the PHP package nicoswd/php-rule-parser without Composer
On this page you can find all versions of the php package nicoswd/php-rule-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nicoswd/php-rule-parser
More information about nicoswd/php-rule-parser
Files in nicoswd/php-rule-parser
Package php-rule-parser
Short Description Rule Engine - Rule Parser & Evaluator
License MIT
Homepage https://github.com/nicoSWD/php-rule-parser
Informations about the package php-rule-parser
PHP Rule Engine
You're looking at a standalone PHP library to parse and evaluate text based rules with a Javascript-like syntax. This project was born out of the necessity to evaluate hundreds of rules that were originally written and evaluated in JavaScript, and now needed to be evaluated on the server-side, using PHP.
This library has initially been used to change and configure the behavior of certain "Workflows" (without changing actual code) in an intranet application, but it may serve a purpose elsewhere.
Find me on Twitter: @nicoSWD
(If you're using PHP 5, you might want to take a look at version 0.4.0)
Install
Via Composer
Bundles
This library works best with one of these bundles below, but they're not required
Bundle | Framework | Packagist |
---|---|---|
nicoSWD/rule-engine-bundle | Symfony |
Usage Examples
Test if a value is in a given array
Simple array manipulation
Test if a value is between a given range
Call methods on objects from within rules
For security reasons, PHP's magic methods like __construct
and __destruct
cannot be
called from within rules. However, __call
will be invoked automatically if available,
unless the called method is defined.
Built-in Methods
Name | Example |
---|---|
charAt | "foo".charAt(2) === "o" |
concat | "foo".concat("bar", "baz") === "foobarbaz" |
endsWith | "foo".endsWith("oo") === true |
startsWith | "foo".startsWith("fo") === true |
indexOf | "foo".indexOf("oo") === 1 |
join | ["foo", "bar"].join(",") === "foo,bar" |
replace | "foo".replace("oo", "aa") === "faa" |
split | "foo-bar".split("-") === ["foo", "bar"] |
substr | "foo".substr(1) === "oo" |
test | "foo".test(/oo$/) === true |
toLowerCase | "FOO".toLowerCase() === "foo" |
toUpperCase | "foo".toUpperCase() === "FOO" |
Built-in Functions
Name | Example |
---|---|
parseInt | parseInt("22aa") === 22 |
parseFloat | parseFloat("3.1") === 3.1 |
Supported Operators
Type | Description | Operator |
---|---|---|
Comparison | greater than | > |
Comparison | greater than or equal to | >= |
Comparison | less than | < |
Comparison | less or equal to | <= |
Comparison | equal to | == |
Comparison | not equal to | != |
Comparison | identical | === |
Comparison | not identical | !== |
Containment | contains | in |
Containment | does not contain | not in |
Logical | and | && |
Logical | or | |\ |
Error Handling
Both, $rule->isTrue()
and $rule->isFalse()
will throw an exception if the syntax is invalid. These calls can either be placed inside a try
/ catch
block, or it can be checked prior using $rule->isValid()
.
Or alternatively:
Both will output: Unexpected token "(" at position 25 on line 3
Syntax Highlighting
A custom syntax highlighter is also provided.
Outputs:
Notes
- Parentheses can be nested, and will be evaluated from right to left.
- Only value/variable comparison expressions with optional logical ANDs/ORs, are supported.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Testing
Contributing
Pull requests are very welcome! If they include tests, even better. This project follows PSR-2 coding standards, please make sure your pull requests do too.
To Do
- Support for object properties (foo.length)
- Support for returning actual results, other than true or false
- Support for array / string dereferencing: "foo"[1]
- Don't force boolean comparison for tokens that are already booleans.
my_func() && 2 > 1
should work - Change regex and implementation for method calls. ".split(" should not be the token
- Add / implement missing methods
- Add "typeof" construct
- Do math (?)
- Allow string concatenating with "+"
- Invalid regex modifiers should not result in an unknown token
- Duplicate regex modifiers should throw an error
Add support for function callsSupport for regular expressionsFix build on PHP 7 / NightlyAllow variables in arraysVerify function and method name spelling (.tOuPpErCAse() is currently valid)- ...