README

Curspell

Curspell (short for currency speller) is a PHP package to spell out currency amounts.

Installation

composer require rahulmac/curspell

Prerequisites

• PHP v8.0+
• The intl extension
• The bcmath extension

Usage

Basic Usage

Simply create an object and invoke spell() with the amount.

By default, it uses USD as the currency code and en_US as the locale.

use Rahulmac\Curspell\Curspell;

echo (new Curspell())->spell(123.45);    // one hundred twenty-three dollars and forty-five cents

Currency Code and Locale

You can change the currency code and locale of your choice.

Note

For now, the package can only spellout amounts in the English language.

use Rahulmac\Curspell\Curspell;

echo (new Curspell())->setCode('INR')->setLocale('en_IN')->spell(123.45);    // one hundred twenty-three rupees and forty-five paise

Supported Currencies

Here is the list of the currencies this package supports.

License

Curspell is open-sourced software licensed under the MIT license.