Download the PHP package subzeta/ruling without Composer
On this page you can find all versions of the php package subzeta/ruling. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download subzeta/ruling
More information about subzeta/ruling
Files in subzeta/ruling
Package ruling
Short Description An stateless rule engine
License MIT
Homepage https://github.com/subzeta/ruling
Informations about the package ruling
Rule engine
Stateless rule engine to assert statements given a context.
Install
Usage example
Calls
There are three main entrances:
interpret
Returns the interpreted rules. Using the example above the output would be: ['80 > 90 || 10 < 20']
assert
Returns a boolean indicating the output. Using the example above the output would be: true
execute
Fires the success or fail callback if defined. Using the example above the output would be: 'Hell yeah, I should listen it!'
Error handling
Different types of exceptions are thrown when something goes wrong:
InvalidContextException
When the provided context isn't valid (accepts: ['string-key-1' => value-1, ..., 'string-key-x' => value-x]).
InvalidRuleException
When the provided rules aren't valid (accepts: 'string' or ['string-1', ..., 'string-x'])
InvalidCallbackException
When the provided success/fail callback isn't callable (accepts: function(){return 'Hey Ho! Let\'s go!';})
Supported Operators
Type | Operator | Representation |
---|---|---|
Comparison | is greater than | > |
Comparison | is greater or equal to | >= |
Comparison | is less than | < |
Comparison | is less or equal to | <= |
Comparison | is equal to (alias: is) | == |
Comparison | is not equal to (aliases: is not, isn't) | != |
Comparison | same as | === |
Comparison | not same as | !== |
Logical | and | && |
Logical | or | |\ |
Containment | contained in (alias: in) | in |
Notes
- It's not necessary to provide callbacks for execute method, it will return a boolean instead as assert does.
- Rules respect the operator precedence and evaluate the parenthesis from right to left.
Testing
Recursive to do list
- Increase the number of unit tests to prevent bad contexts or bad formatted rules from being executed.
To do
- Improve the interpreted method response.
Changelist
- Allow aliases ("is equal to" can be written as "is" and "is not equal to" as "is not"/"isn't").
- Context values may permit callable functions too.
- Added the strict comparison operators (same as, not same as).
- It can be interesting to implement a kind of dump method to show the interpreted rule.
- Added the "in" operator.
- Context accepts array values.
License
MIT