ls-a/arithmetic-ast

Implements the Shunting Yard Algorithm and creates an Abstract Syntax Tree with arithmetic operations

dev-main 2025-11-11 18:00 UTC

Requires

• php: ^8.0.0

Requires (Dev)

• laravel/pint: ^1.22
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.1
• squizlabs/php_codesniffer: ^4.0

GPL-3.0-or-later

• ls-a

• math
• utils
• ast
• arithmetic
• comparison
• operation
• shunting
• yard

README

This documentation is also available in these languages:

• Français

This library provides a implementation of Abstract Syntax Tree for arithmetic operations.
For more information, see these links:

• https://en.wikipedia.org/wiki/Abstract_syntax_tree
• https://en.wikipedia.org/wiki/Reverse_Polish_notation
• https://en.wikipedia.org/wiki/Shunting_yard_algorithm

Code sample:

<?php

$tokens = [
    TokenParser::parse('1 + 2 * 3'),
    TokenParser::parse('1 + (2 * 3 % 5 - (2 + 3 + 4) + (5 / 2)) + (3 * 4)'),
    TokenParser::parse('(mock(1, 2) + 2.6) / 2'),
    TokenParser::parse('mock-with-dashes(mock-with-dashes(mock-with-dashes(2)))')
];

Features

This library includes :

• Support for following operators : +, -, *, /, %
• Allowance to create new operators, with custom symbols, whether single character or string
• Unary operator managament
• Functions support
• Function string parameters
• Variadic function parameters
• Support for following units: mm, cm, pt, pc, in, % and related converters, plus support to create your own

For every operation, you can use evaluate method to get its result.

Why?

First, because why not? We could not find an arithmetic abstract syntax tree on composer and felt it was missing.
Next, for a little background, this package is used in XSL-Core package, to handle various XML function calls in attributes.

Installation

This library is available on Composer. Install it with:

composer require ls-a/arithmetic-ast

Changelog

Please refer to the CHANGELOG file to see the latest changes.

Support

We put our heart into delivering high-quality products that are accessible to everyone. If you like our work, don’t hesitate to reach out to us for your next project!

Contributing

Contributions are governed by the CONTRIBUTING file.

Security

If you’ve found a bug or vulnerability, please contact us by email at [e-mail] instead of opening an issue, in order to protect the security of other users.

Credits

• Renaud Berthier

License

The MIT License (MIT). Please see License File for more information.