archtechx/money
1
0
Fork 0
mirror of https://github.com/archtechx/money.git synced 2025-12-12 03:14:03 +00:00
Code Activity

feature: money instance creation from a formatted string

Browse source
This commit is contained in:
Gaurav 2022-03-09 12:50:04 +05:30
parent 8bdf0d1a2b
commit 38c6326a4d
4 changed files with 53 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -143,7 +143,7 @@ $money->decimals(); // 100.0
### Formatting money
You can format money using the `->formatted()` method:
You can format money using the `->formatted()` method. It takes [display decimals](#display-decimals) into consideration.
```php
$money = Money::fromDecimal(40.25, USD::class);
@ -166,6 +166,22 @@ $money = Money::fromDecimal(40.25, USD::class);
$money->formatted(['decimalSeparator' => ',', 'prefix' => '$ ', 'suffix' => ' USD']);
```
There is also a `->rawFormatted()` if you wish to use [math decimals](#math-decimals) instead of [display decimals](#display-decimals).
```php
$money = Money::new(123456, CZK::class);
$money->rawFormatted(); // 1 235,56 Kč
```
And converting the formatted value back to the Money instance is also possible:
```php
$money = money(1000);
$formatted = $money->formatted(); // $10.00
$fromFormatted = Money::fromFormatted($formatted);
$fromFormatted->is($money); // true
```
Note: `fromFormatted()` misses the cents if the [math decimals](#math-decimals) are greater than [display decimals](#display-decimals).
### Rounding money
Some currencies, such as the Czech Crown (CZK), generally display final prices in full crowns, but use cents for the intermediate math operations. For example:
@ -414,7 +430,7 @@ For the Czech Crown (CZK), the display decimals will be `0`, but the math decima
For the inverse of what was just explained above, you can use the `rawFormatted()` method. This returns the formatted value, **but uses the math decimals for the display decimals**. Meaning, the value in the example above will be displayed including cents:
```php
money(123456, new CZK)->rawFormatted(); // 1 235,56 Kč
money(123456, new CZK)->rawFormatted(); // 1 234,56 Kč
```
This is mostly useful for currencies like the Czech Crown which generally don't use cents, but **can** use them in specific cases.