spryker / decimal-object
PHP decimal handling as value object
Installs: 2 385 994
Dependents: 37
Suggesters: 1
Security: 0
Stars: 22
Watchers: 64
Forks: 9
Open Issues: 4
Requires
- php: >=7.2
- ext-bcmath: *
- ext-json: *
Requires (Dev)
- phpstan/phpstan: ^0.12
- phpunit/phpunit: ^8.0.0 || ^9.0.0
- spryker/code-sniffer: @stable
README
Decimal value object for PHP.
Background
When working with 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 string is a workaround, but as value object you can more easily encapsulate some of the logic.
Alternatives
Solutions like https://php-decimal.io require a PHP extension (would make it faster, but also more difficult for some servers to be available). For details see the wiki.
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 spryker/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.