tnkemdilim/money-to-words-converter

A php library that converts any money value in digit in any language or numeric system to its words in any language

Money To Words Converter

, _(*1)

A php library that converts any money value in digit in any language or numeric system to its words in any language, _(*2)

Caveat

Currently, this library relies on stichoza/google-translate-php which could result in periodic 400 Bad Request as highlighted here and here., _(*3)

If you care about reliability, kindly checkout a managed API service I run: Tuforty., _(*4)

Installation

• Install this package via Composer.

composer require tnkemdilim/money-to-words-converter

• Or edit your project's composer.json to require tnkemdilim/money-to-words-converter and then run composer update.

"require": {
    "tnkemdilim/money-to-words-converter": "^2"
}

Example

For working example, checkout the Example folder., _(*5)

Usage

Note: You should have composer's autoloader included require 'vendor/autoload.php', _(*6)

Always include Converter namespace to your php file, _(*7)

Basic usage

use TNkemdilim\MoneyToWords\Converter;

// Nigerian currency : naira & kobo
$converter = new Converter("naira", "kobo");
echo ($converter->convert(374));
echo ($converter->convert(23.45));
echo ($converter->convert(748247284782));
echo ($converter->convert(748247284782.34));
echo ($converter->convert('34'));
echo ($converter->convert('2345.34'));
echo ($converter->convert('3453345'));

Other Languages

To convert money value to other languages, you'll need to import the Languages namespace, _(*8)

use TNkemdilim\MoneyToWords\Converter;
use TNkemdilim\MoneyToWords\Languages as Language;

$converter = new Converter("naira", "kobo", Language::FRENCH);

echo ($converter->convert(23.45));
echo ($converter->convert("748247284782"));

Convertion From Other Numeric System

Conversion from other numeric systems are supported in-built, and by default needs no extra configuration to convert into words., _(*9)

Read more about Numeric systems., _(*10)

// Chinese numeric system
$money = "八百七十二万七千八百二十四";

// Example 1
$converter = new Converter("yen", "sen");
echo ($converter->convert($money));

// Example 2: but convert money value to french
$frenchConverter = new Converter("yen", "sen", Language::FRENCH);
echo ($frenchConverter->convert("八百七十二万七千八百二十四"));

Change Currency

To change the currency of the money to convert, _(*11)

//  Dollars & Cents
$converter->setCurrency("dollar", "cents");
echo ($converter->convert(234.34)); // two hundred and thirty-four dollars, thirty-four cents only.

// Pounds & Pence
$converter->setCurrency("pounds", "pence");
echo ($converter->convert('23.3')); // twenty three pounds, 3 pence only.

Change Language Translation

Language for translation can be easily changed as follows. All available languages can be accessed via the TNkemdilim\MoneyToWords\Languages class., _(*12)

See all available in Languages., _(*13)

use TNkemdilim\MoneyToWords\Languages as Language;

$converter->setLanguage(Language::LATIN);
$converter->setLanguage(Language::SWAHILI);
$converter->setLanguage(Language::GREEK);

Supported Languages

For more conversion types, _(*14)

Contribution

1. Fork it!
2. Create your feature branch: git checkout -b feature-name
3. Commit your changes: git commit -am 'Some commit message'
4. Push to the branch: git push origin feature-name
5. Submit a pull request 😉😉

License

MIT © Tochukwu Nkemdilim, _(*15)