PHP Classes

PHP Math Expression Evaluator: Parse and evaluate strings with math expressions

Recommend this page to a friend!

  Author Author  
Picture of Alexander Kiryukhin
Name: Alexander Kiryukhin <contact>
Classes: 2 packages by
Country: Russian Federation Russian Federation
Age: ???
All time rank: 236869 in Russian Federation Russian Federation
Week rank: 597 Up21 in Russian Federation Russian Federation Up


  Detailed description   Download Download .zip .tar.gz   Install with Composer Install with Composer  
This class can parse and evaluate strings with math expressions.

It can take a string with a math expression and evaluates it by computing the result of operations.

The class can be extended to handle new operations by specifying the operator symbol, priority of the operation and a callback function that will be used to evaluate the result of the operation.

Details

MathExecutor Tests

A simple and extensible math expressions calculator

Features:

  • Built in support for +, -, *, /, % and power (^) operators
  • Paratheses () and arrays [] are fully supported
  • Logical operators (==, !=, <, <, >=, <=, &&, ||)
  • Built in support for most PHP math functions
  • Support for BCMath Arbitrary Precision Math
  • Support for variable number of function parameters and optional function parameters
  • Conditional If logic
  • Support for user defined operators
  • Support for user defined functions
  • Support for math on user defined objects
  • Dynamic variable resolution (delayed computation)
  • Unlimited variable name lengths
  • String support, as function parameters or as evaluated as a number by PHP
  • Exceptions on divide by zero, or treat as zero
  • Unary Plus and Minus (e.g. +3 or -sin(12))
  • Pi ($pi) and Euler's number ($e) support to 11 decimal places
  • Easily extensible

Install via Composer:

composer require nxp/math-executor

Sample usage:

use NXP\MathExecutor;

$executor = new MathExecutor();

echo $executor->execute('1 + 2 * (2 - (4+10))^2 + sin(10)');

Functions:

Default functions: * abs * acos (arccos) * acosh * arcctg (arccot, arccotan) * arcsec * arccsc (arccosec) * array * asin (arcsin) * atan (atn, arctan, arctg) * atan2 * atanh * avg * bindec * ceil * cos * cosec (csc) * cosh * ctg (cot, cotan, cotg, ctn) * decbin * dechex * decoct * deg2rad * exp * expm1 * floor * fmod * hexdec * hypot * if * intdiv * log (ln) * log10 (lg) * log1p * max * min * octdec * pi * pow * rad2deg * round * sec * sin * sinh * sqrt * tan (tn, tg) * tanh

Add custom function to executor:

$executor->addFunction('concat', function($arg1, $arg2) {return $arg1 . $arg2;});

Optional parameters:

$executor->addFunction('round', function($num, int $precision = 0) {return round($num, $precision);});
$executor->calculate('round(17.119)'); // 17
$executor->calculate('round(17.119, 2)'); // 17.12

Variable number of parameters:

$executor->addFunction('avarage', function(...$args) {return array_sum($args) / count($args);});
$executor->calculate('avarage(1,3)'); // 2
$executor->calculate('avarage(1, 3, 4, 8)'); // 4

Operators:

Default operators: + - * / % ^

Add custom operator to executor:

use NXP\Classes\Operator;

$executor->addOperator(new Operator(
    '%', // Operator sign
    false, // Is right associated operator
    180, // Operator priority
    function (&$stack)
    {
       $op2 = array_pop($stack);
       $op1 = array_pop($stack);
       $result = $op1->getValue() % $op2->getValue();

       return $result;
    }
));

Logical operators:

Logical operators (==, !=, <, <, >=, <=, &&, ||) are supported, but logically they can only return true (1) or false (0). In order to leverage them, use the built in if function:

if($a > $b, $a - $b, $b - $a)

You can think of the if function as prototyped like:

function if($condition, $returnIfTrue, $returnIfFalse)

Variables:

Variables can be prefixed with the dollar sign ($) for PHP compatibility, but is not required.

Default variables:

$pi = 3.14159265359
$e  = 2.71828182846

You can add your own variables to executor:

$executor->setVar('var1', 0.15)->setVar('var2', 0.22);

echo $executor->execute("$var1 + var2");

Arrays are also supported (as variables, as func params or can be returned in user defined funcs):

$executor->setVar('monthly_salaries', [1800, 1900, 1200, 1600]);

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

$executor->setVarValidationHandler(function (string $name, $variable) {
    // allow all scalars, array and null
    if (is_scalar($variable) || is_array($variable) || $variable === null) {
        return;
    }
    // Allow variables of type DateTime, but not others
    if (! $variable instanceof \DateTime) {
        throw new MathExecutorException("Invalid variable type");
    }
});

You can dynamically define variables at run time. If a variable has a high computation cost, but might not be used, then you can define an undefined variable handler. It will only get called when the variable is used, rather than having to always set it initially.

$calculator = new MathExecutor();
$calculator->setVarNotFoundHandler(
    function ($varName) {
        if ($varName == 'trans') {
            return transmogrify();
        }
        return null;
    }
);

Floating Point BCMath Support

By default, MathExecutor uses PHP floating point math, but if you need a fixed precision, call useBCMath(). Precision defaults to 2 decimal points, or pass the required number. WARNING: Functions may return a PHP floating point number. By doing the basic math functions on the results, you will get back a fixed number of decimal points. Use a plus sign in front of any stand alone function to return the proper number of decimal places.

Division By Zero Support:

Division by zero throws a \NXP\Exception\DivisionByZeroException by default

try {
    echo $executor->execute('1/0');
} catch (DivisionByZeroException $e) {
    echo $e->getMessage();
}

Or call setDivisionByZeroIsZero

echo $executor->setDivisionByZeroIsZero()->execute('1/0');

If you want another behavior, you can override division operator:

$executor->addOperator("/", false, 180, function($a, $b) {
    if ($b == 0) {
        return null;
    }
    return $a / $b;
});
echo $executor->execute('1/0');

String Support:

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.

echo $executor->execute("1 + '2.5' * '.5' + myFunction('category')");

To use reverse solidus character (&#92;) in strings, or to use single quote character (') in a single quoted string, or to use double quote character (") in a double quoted string, you must prepend reverse solidus character (&#92;).

echo $executor->execute("countArticleSentences('My Best Article\'s Title')");

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 behaviors, the easiest way to extend MathExecutor is to redefine the following methods in your derived class: * defaultOperators * defaultFunctions * defaultVars

This will allow you to remove functions and operators if needed, or implement different types more simply.

Also note that you can replace an existing default operator by adding a new operator with the same regular expression string. For example if you just need to redefine TokenPlus, you can just add a new operator with the same regex string, in this case '\\+'.

Documentation

Full class documentation via PHPFUI/InstaDoc

Future Enhancements

This package will continue to track currently supported versions of PHP.


  Classes of Alexander Kiryukhin  >  PHP Math Expression Evaluator  >  Download Download .zip .tar.gz  >  Support forum Support forum (9)  >  Blog Blog  >  RSS 1.0 feed RSS 2.0 feed Latest changes  
Name: PHP Math Expression Evaluator
Base name: math-executor
Description: Parse and evaluate strings with math expressions
Version: 0.35
PHP version: 5.4
License: GNU General Public License (GPL)
All time users: 729 users
All time rank: 4549
Week users: 0 users
Week rank: 163 Equal
 
  Groups   Rate classes User ratings   Applications   Files Files  

  Groups  
Group folder image PHP 5 Classes using PHP 5 specific features View top rated classes
Group folder image Math Math related classes. View top rated classes


  User ratings  
Not enough user ratings

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.

  Files folder image Files  
File Role Description
Files folder image.github (1 directory)
Files folder imagesrc (1 directory)
Files folder imagetests (2 files)
Accessible without login Plain text file .php-cs-fixer.php Example Example script
Accessible without login Plain text file code-of-conduct.md Data Auxiliary data
Accessible without login Plain text file code-of-conduct.ru.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Data Auxiliary data
Accessible without login Plain text file phpstan.neon Data Auxiliary data
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README.md Doc. Read me

  Files folder image Files  /  .github  
File Role Description
Files folder imageworkflows (1 file)

  Files folder image Files  /  .github  /  workflows  
File Role Description
  Accessible without login Plain text file tests.yml Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
Files folder imageNXP (1 file, 2 directories)

  Files folder image Files  /  src  /  NXP  
File Role Description
Files folder imageClasses (5 files)
Files folder imageException (9 files)
  Plain text file MathExecutor.php Class Class source

  Files folder image Files  /  src  /  NXP  /  Classes  
File Role Description
  Plain text file Calculator.php Class Class source
  Plain text file CustomFunction.php Class Class source
  Plain text file Operator.php Class Class source
  Plain text file Token.php Class Class source
  Plain text file Tokenizer.php Class Class source

  Files folder image Files  /  src  /  NXP  /  Exception  
File Role Description
  Plain text file DivisionByZeroException.php Class Class source
  Plain text file IncorrectBracketsException.php Class Class source
  Plain text file IncorrectExpressionException.php Class Class source
  Plain text file IncorrectFunctionParameterException.php Class Class source
  Plain text file IncorrectNumberOfF...metersException.php Class Class source
  Plain text file MathExecutorException.php Class Class source
  Plain text file UnknownFunctionException.php Class Class source
  Plain text file UnknownOperatorException.php Class Class source
  Plain text file UnknownVariableException.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Accessible without login Plain text file bootstrap.php Test Unit test script
  Accessible without login Plain text file MathTest.php Test Unit test script

Install with Composer Install with Composer - Download Download all files: math-executor.tar.gz math-executor.zip
NOTICE: if you are using a download manager program like 'GetRight', please Login before trying to download this archive.
For more information send a message to info at phpclasses dot org.