https://github.com/ngekoding/php-terbilang
A library to convert numbers and currency to words in Indonesian.
https://github.com/ngekoding/php-terbilang
currency-to-words numbers-to-words php-terbilang terbilang
Last synced: about 2 months ago
JSON representation
A library to convert numbers and currency to words in Indonesian.
- Host: GitHub
- URL: https://github.com/ngekoding/php-terbilang
- Owner: ngekoding
- License: mit
- Created: 2024-06-13T15:04:04.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-06-21T01:55:27.000Z (11 months ago)
- Last Synced: 2025-03-12T12:47:32.152Z (2 months ago)
- Topics: currency-to-words, numbers-to-words, php-terbilang, terbilang
- Language: PHP
- Homepage: https://packagist.org/packages/ngekoding/terbilang
- Size: 9.77 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Terbilang
PHP Terbilang is a library that converts number or currency amount into their Indonesian words representation.
## Features
- Converts number values to words in Indonesian.
- Converts currency amounts (in rupiah) to words.
- Supported decimals (comma) for both regular number and currency.
## Installation
You can install via composer:
```sh
composer require ngekoding/terbilang
```
## Usage
### Basic Usage
This is how to convert a regular number to words:
```php
use Ngekoding\Terbilang\Terbilang;
echo Terbilang::convert(12345); // Outputs: "dua belas ribu tiga ratus empat puluh lima"
echo Terbilang::convert(12345.67); // Outputs: "dua belas ribu tiga ratus empat puluh lima koma enam tujuh"
```
Then pass the second paramater to `true` for currency amount:
```php
echo Terbilang::convert(12345, true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah"
echo Terbilang::convert(12345.67, true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah enam puluh tujuh sen"
```
### Options
You can customize the decimal separator for your conversions:
```php
// Convert with a custom decimal separator (e.g., ',')
echo Terbilang::convert('12345,67', true, ','); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah enam puluh tujuh sen"
// Or you can change it globally
Terbilang::setDecimalSeparator(',');
echo Terbilang::convert('12345,67'); // Outputs: "dua belas ribu tiga ratus empat puluh lima koma enam tujuh"
echo Terbilang::convert('12345,25', true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah dua puluh lima sen"
```
**Note:** Will affected only for string input.
### Advanced Usage
You can use either numeric or string inputs, but there are some important considerations when dealing with decimals.
For **regular numbers**, when using numeric input, trailing zeros after the decimal point are not preserved. For example, the number `12345.500` will be presented as `12345.5`.
Especially for **currency amounts**, two decimal places are always used to adhere to rupiah standards.
To handle the entire input number, including trailing zeros after the decimal point, use string input.
```php
echo Terbilang::convert(12345.50); // Outputs: "dua belas ribu tiga ratus empat puluh lima koma lima"
echo Terbilang::convert('12345.50'); // Outputs: "dua belas ribu tiga ratus empat puluh lima koma lima nol"
echo Terbilang::convert('12345.500'); // Outputs: "dua belas ribu tiga ratus empat puluh lima koma lima nol nol"
echo Terbilang::convert(12345.5, true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah lima puluh sen"
echo Terbilang::convert(12345.50, true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah lima puluh sen"
echo Terbilang::convert(12345.505, true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah lima puluh satu sen"
echo Terbilang::convert('12345.500', true); // Outputs: "dua belas ribu tiga ratus empat puluh lima rupiah lima ratus sen"
```
Additionally, with string input, you can easily pass already formatted numbers.
```php
echo Terbilang::convert('Rp1.500.100,50', true, ','); // Outputs: "satu juta lima ratus ribu seratus rupiah lima puluh sen"
```
For currency amounts with `,00` decimals, the decimal part will be ignored, as this is the correct format for writing rupiah.
```php
echo Terbilang::convert('Rp1.500.100,00', true, ','); // Outputs: "satu juta lima ratus ribu seratus rupiah"
```
## API
```php
Terbilang::convert($number, $isCurrency = false, $decimalSeparator = null)
```
Converts a number or currency amount into its Indonesian words representation.
- **$number** (mixed): The number or currency amount to convert.
- **$isCurrency** (bool, optional): Whether the conversion is for currency (default: false).
- **$decimalSeparator** (string, optional): The decimal separator used in the number (default: '.').
## References
This library aims to adhere to Indonesian language standards.
- [Pedoman Umum Ejaan Bahasa Indonesia (PUEBI)](https://badanbahasa.kemdikbud.go.id/lamanbahasa/sites/default/files/PUEBI.pdf)
- [Kamus Besar Bahasa Indonesia (KBBI) Kemdikbud](https://kbbi.kemdikbud.go.id)
## Testing
```sh
composer test
```
## Contributing
Feel free to contribute to improve this library. Fork it, make changes, and submit a pull request.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.