README

Laravel Currency Converter: Effortlessly convert currencies in your Laravel applications, no API key required. It's fast, easy, and completely free.

📦 Installation

You can install the package via composer:

composer require mgcodeur/laravel-currency-converter

After Composer has installed the Laravel Currency Converter package, you may run the currency-converter:install Artisan command:

php artisan currency-converter:install

✍🏻 Basic Usage

Convert money from one to another

// convert 10 USD to MGA
$convertedAmount = CurrencyConverter::convert(10)
            ->from('USD')
            ->to('MGA')
            ->get();

dd($convertedAmount);

NB: Don't Forget to import the CurrencyConverter Facades

use Mgcodeur\CurrencyConverter\Facades\CurrencyConverter;

Convert all money from one

You can convert all money from one currency when you don't specify the to method.

// convert 5 EUR to all currencies
$convertedAmount = CurrencyConverter::convert(5)
            ->from('EUR')
            ->get();

dd($convertedAmount);

Get all currencies

To get all currencies, you can use the currencies method.

$currencies = CurrencyConverter::currencies()->get();

dd($currencies);

Format output result

Instead of using the get method, you can use the format method to format the output result.

// convert 10 USD to EUR and format the result
$convertedAmount = CurrencyConverter::convert(10)
            ->from('USD')
            ->to('EUR') // The 'to' method specifies the target currency. If you want to convert between all currencies, you can omit this method.
            ->format();

dd($convertedAmount);

By default, thousand separator is a comma (,) and decimal separator is a dot (.). You can change these separators in published config file (config/currency-converter.php).
If you open the config file, you will see the following code:

return [
    'currency' => [
        'format' => [
            'decimals' => 2, // Number of decimal places
            'decimal_separator' => ',', // Decimal separator: used to separate the integer part from the fractional part (e.g., 1,99)
            'thousand_separator' => '.', // Thousand separator: used to separate groups of thousands in large numbers (e.g., 1.000 for one thousand)
        ]
    ],
];

🪴 Project Activity