Stars: 332
Forks: 141
Pull Requests: 120
Issues: 42
Watchers: 16
Last Updated: 2023-09-16 15:35:21
Number to string standalone PHP library with i18n. Drivers for numbers and currency included.
License: MIT License
Languages: PHP, Makefile
This library converts numbers to their word representation (123 -> one hundred twenty three).
Add package to your composer.json by running:
$ composer require kwn/number-to-words
There are two types of number-to-words transformation: number and currency. In order to use a relevant transformer for specific language create an instance of NumberToWords
class and call a method that creates a new instance of the desired transformer;
Create a transformer for specific language using the getNumberTransformer('lang')
method:
use NumberToWords\NumberToWords;
// create the number to words "manager" class
$numberToWords = new NumberToWords();
// build a new number transformer using the RFC 3066 language identifier
$numberTransformer = $numberToWords->getNumberTransformer('en');
Transformer can be used by passing in numeric values to the toWords()
method:
$numberTransformer->toWords(5120); // outputs "five thousand one hundred twenty"
It can be also used with a static method:
NumberToWords::transformNumber('en', 5120); // outputs "five thousand one hundred twenty"
Creating a currency transformer works just like a number transformer.
use NumberToWords\NumberToWords;
// create the number to words "manager" class
$numberToWords = new NumberToWords();
// build a new currency transformer using the RFC 3066 language identifier
$currencyTransformer = $numberToWords->getCurrencyTransformer('en');
Then it can be used passing in numeric values for amount and ISO 4217 currency identifier to the toWords()
method:
$currencyTransformer->toWords(5099, 'USD'); // outputs "fifty dollars ninety nine cents"
It can be also used with a static method:
NumberToWords::transformCurrency('en', 5099, 'USD'); // outputs "fifty dollars ninety nine cents"
Please keep in mind, the currency transformer accepts integers as the amount to transform. It means that if you store amounts as floats (e.g. 4.99) you need to multiply them by 100 and pass the integer (499) as an argument.
Language | Identifier | Number | Currency |
---|---|---|---|
Albanian | al | + | + |
Arabic | ar | + | + |
Azerbaijani | az | + | + |
Belgian French | fr_BE | + | - |
Brazilian Portuguese | pt_BR | + | + |
Bulgarian | bg | + | - |
Czech | cs | + | - |
Danish | dk | + | + |
Dutch | nl | + | - |
English | en | + | + |
Estonian | et | + | - |
Georgian | ka | + | + |
German | de | + | + |
French | fr | + | + |
Hungarian | hu | + | + |
Indonesian | id | + | + |
Italian | it | + | - |
Kurdish | ku | + | - |
Lithuanian | lt | + | + |
Latvian | lv | + | + |
Macedonian | mk | + | - |
Malay | ms | + | + |
Persian | fa | + | - |
Polish | pl | + | + |
Romanian | ro | + | + |
Serbian | sr | + | + |
Slovak | sk | + | + |
Spanish | es | + | + |
Russian | ru | + | + |
Swedish | sv | + | - |
Turkish | tr | + | + |
Turkmen | tk | + | + |
Ukrainian | ua | + | + |
Yoruba | yo | + | + |
Many transformers were ported from the pear/Numbers_Words
library. Some of them were created from scratch by contributors. Thank you!
NumberTransformer
and CurrencyTransformer
interfaces. Now both accept integer numbers only (Albanian language might be affected).Q: I found a bug. What should I do?
A: Please report an issue on GitHub. Feel free to fix it and open a pull request. I don't know most of those languages that the library supports, so your help and contribution would be much appreciated. Thanks!
Q: My language is missing. Could it be added?
A: Unfortunately, there's a high chance I don't know your language. Feel free to implement the missing transformer and open a pull request. You can take a look at the existing transformers, and follow the same pattern as other languages do.