NeonXP/MathExecutor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Release Prep (#109)

Browse source
This commit is contained in:
Bruce Wells 2022-05-16 18:18:37 -04:00 committed by GitHub
parent 5d6b4a5dfd
commit ddf9dbfe0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -3,7 +3,8 @@
# A simple and extensible math expressions calculator # A simple and extensible math expressions calculator
## Features: ## Features:
* Built in support for +, -, *, / and power (^) operators plus () * Built in support for +, -, *, / and power (^) operators
* Paratheses () and arrays [] are fully supported
* Logical operators (==, !=, <, <, >=, <=, &&, ||) * Logical operators (==, !=, <, <, >=, <=, &&, ||)
* Built in support for most PHP math functions * Built in support for most PHP math functions
* Conditional If logic * Conditional If logic
@ -150,19 +151,18 @@ $executor->setVar('monthly_salaries', [1800, 1900, 1200, 1600]);
echo $executor->execute("avg(monthly_salaries) * min([1.1, 1.3])"); echo $executor->execute("avg(monthly_salaries) * min([1.1, 1.3])");
``` ```
By default, variables must be scalar values (int, float, bool or string) or array. If you would like to support another type, use **setVarValidationHandler** By default, variables must be scalar values (int, float, bool or string) or array. If you would like to support another type, use **setVarValidationHandler**
```php ```php
$executor->setVarValidationHandler(function (string $name, $variable) { $executor->setVarValidationHandler(function (string $name, $variable) {
// allow all scalars, array and null // allow all scalars, array and null
if (is_scalar($variable) || is_array($variable) || $variable === null) { if (is_scalar($variable) || is_array($variable) || $variable === null) {
return; return;
} }
// Allow variables of type DateTime, but not others // Allow variables of type DateTime, but not others
if (! $variable instanceof \DateTime) { if (! $variable instanceof \DateTime) {
throw new MathExecutorException("Invalid variable type"); throw new MathExecutorException("Invalid variable type");
} }
}); });
``` ```
@ -205,14 +205,14 @@ echo $executor->execute('1/0');
``` ```
## String Support: ## String Support:
Expressions can contain double or single quoted strings that are evaluated the same way as PHP evalutes strings as numbers. You can also pass strings to functions. Expressions can contain double or single quoted strings that are evaluated the same way as PHP evaluates strings as numbers. You can also pass strings to functions.
```php ```php
echo $executor->execute("1 + '2.5' * '.5' + myFunction('category')"); echo $executor->execute("1 + '2.5' * '.5' + myFunction('category')");
``` ```
## Extending MathExecutor ## Extending MathExecutor
You can add operators, functions and variables with the public methods in MathExecutor, but if you need to do more serious modifications to base behaviours, the easiest way to extend MathExecutor is to redefine the following methods in your derived class: You can add operators, functions and variables with the public methods in MathExecutor, but if you need to do more serious modifications to base behaviors, the easiest way to extend MathExecutor is to redefine the following methods in your derived class:
* defaultOperators * defaultOperators
* defaultFunctions * defaultFunctions
* defaultVars * defaultVars