php-collective / decimal-object
PHP decimal handling as value object
Installs: 18 840
Dependents: 1
Suggesters: 0
Security: 0
Stars: 20
Watchers: 1
Forks: 4
Open Issues: 1
Requires
- php: >=8.1
- ext-bcmath: *
- ext-json: *
Requires (Dev)
- php-collective/code-sniffer: ^0.2.1
- phpstan/phpstan: ^1.0.0
- phpunit/phpunit: ^10.3.0
README
Decimal value object for PHP.
Background
When working with decimal (e.g. monetary) values, normal data types like int or float are not suitable for exact arithmetic. Try out the following in PHP:
var_dump(0.1 + 0.2); // float(0.3) var_dump(0.1 + 0.2 - 0.3); // float(5.5511151231258E-17)
Handling them as strings is a workaround, but as value object you can more easily encapsulate some of the logic.
Alternatives
Solutions like php-decimal require a custom PHP extension (would make it faster, but also more difficult for some servers to be available). Monetary values themselves could be handled also with brick/money or moneyphp/money.
For details see the wiki.
Note: If you are looking for pre PHP 8.1 versions, check out the legacy library.
Features
- Super strict on precision/scale. Does not lose significant digits on its own. You need to
trim()
for this manually. - Speaking API (no le, gt methods).
- Basic math operations and checks supported.
- Immutability.
- Handle very large and very small numbers.
Installation
Requirements
bcmath
PHP extension enabled
Composer (preferred)
composer require php-collective/decimal-object
Usage
See Documentation for more details.
Implementations
The following libraries are using the Decimal
value object:
- dereuromark/cakephp-decimal as decimal type replacement for CakePHP ORM.
The original library here was written 2019 for Spryker ecommerce framework and since then battle-tested through millions of customers and orders as well as other complex calculations under the hood. This here is the freshly upgraded and independently maintained version for the PHP ecosystem as a whole.
Enjoy!