README

A PHP Package to convert Amount from one currency to the other.

Requirements

PHP >= 7.3

Installation

Install currency using composer require:

composer require chandachewe/currency

Enter the currency directory and run the following code

composer install

Add the namespaces and vendor/autoload in the file you will be doing your conversions from. Am assuming the file and the vendor are both in the root directory. In your file include the following on top:

 require 'vendor/autoload.php';  
 use Chandachewe\Currency\DriverAccessKeys\ExchangeRateDriverAccessKey; 
 use Chandachewe\Currency\Drivers\ExchangeConverter;
 use Chandachewe\Currency\Drivers\ExchangeRate;
 use Chandachewe\Currency\CurrencyConverted;
 use Chandachewe\Currency\CurrencyFormats;

Usage

Convert Amount from One Currency to the other

You can convert the amount from one currency to the other using the following code:

ExchangeRateDriverAccessKey::$exchangerate_access_key = 'YOUR ACCESS KEY HERE';
ExchangeConverter::convert('amount', 'from this currency', 'to this currency');

Important: See the supported currency formats below. Use of unsupported formats will throw an exception

Suppose I want to convert 10 USD to GBP then my code will be:

ExchangeRateDriverAccessKey::$exchangerate_access_key = 'YOUR ACCESS KEY HERE';
echo ExchangeConverter::convert(10, 'USD', 'GBP');

Then you can retrieve the result as follows:

echo CurrencyConverted::$currency_conversion

Obtain the Exchange rate between two currencies

You can also obtain the exchange rates between two currencies as follows:

ExchangeRateDriverAccessKey::$exchangerate_access_key = 'YOUR ACCESS KEY HERE';
ExchangeRate::exchange('from this currency', 'to this currency');

Suppose I want to obtain the exchange rate between 1 USD and the GBP then my code will be as follows:

ExchangeRateDriverAccessKey::$exchangerate_access_key = 'YOUR ACCESS KEY HERE';
echo ExchangeRate::exchange('USD', 'GBP');

Then you can retrieve the result as follows:

echo CurrencyConverted::$currency_rate;

Drivers

Available Drivers

Exchangerates

Versioning

Releases will be numbered with the following format:

<major>.<minor>.<patch>

chandachewe / currency

Maintainers

Details