https://github.com/tomwright/currencyphp
A small package to facilitate currency conversions in PHP.
https://github.com/tomwright/currencyphp
conversion-rate currency currency-converter currency-exchange-rates php
Last synced: 2 months ago
JSON representation
A small package to facilitate currency conversions in PHP.
- Host: GitHub
- URL: https://github.com/tomwright/currencyphp
- Owner: TomWright
- Created: 2017-02-02T14:49:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-24T11:56:48.000Z (over 7 years ago)
- Last Synced: 2025-02-06T09:48:14.651Z (4 months ago)
- Topics: conversion-rate, currency, currency-converter, currency-exchange-rates, php
- Language: PHP
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CurrencyPHP
[](https://travis-ci.org/TomWright/CurrencyPHP)
[](https://packagist.org/packages/tomwright/currency-php)
[](https://packagist.org/packages/tomwright/currency-php)
[](https://packagist.org/packages/tomwright/currency-php)
[](https://packagist.org/packages/tomwright/currency-php)
[](https://packagist.org/packages/tomwright/currency-php)
## Installation
```
composer install tomwright/currency-php
```
## Usage
CurrencyPHP is just a basic wrapper. It cannot do conversions out of the box... Saying that... you only need to provide it with the conversion rates.
```php
$rateFetcher = new MyConversionRateFetcher();
$factory = new CurrencyFactory($rateFetcher);
$gbp = $factory->create('GBP');
$usd = $factory->create('USD');
$priceInGBP = 100;
$priceInUSD = $gbp->convertTo($usd, $priceInGBP);
echo $priceInUSD; // 126
```
## Rate Fetchers
Rate Fetchers are what `CurrencyPHP` uses to get conversion rates. Any Rate Fetcher you create should implement `ConversionRateFetcherInterface`.
### Existing Rate Fetchers
- [Fixer IO](https://github.com/TomWright/CurrencyPHPFixerIORateFetcher)
- [Yahoo Currency API](https://github.com/TomWright/CurrencyPHPYahooRateFetcher)
If you have created your own Rate Fetcher and want it included here, please submit a pull request.
### Creating Your Own
The following Rate Fetcher gives you some fixed exchange rates:
- GBP to USD
- USD to GBP
- GBP to CAD
- CAD to USD
```php
class FixedRateFetcher implements ConversionRateFetcherInterface
{
/**
* @param Currency $from
* @param Currency $to
* @return float
*/
public function getConversionRate(Currency $from, Currency $to)
{
$rates = [
[
'from' => 'GBP',
'to' => 'USD',
'rate' => 1.2547,
],
[
'from' => 'USD',
'to' => 'GBP',
'rate' => 0.7974,
],
[
'from' => 'GBP',
'to' => 'CAD',
'rate' => 1.6612,
],
[
'from' => 'CAD',
'to' => 'USD',
'rate' => 0.7539,
],
];
$result = null;
foreach ($rates as $rate) {
if ($rate['from'] === $from->getCurrencyCode() && $rate['to'] === $to->getCurrencyCode()) {
$result = $rate['rate'];
}
}
return $result;
}
}
```
### Handling unknown conversion rates
#### One way conversion rates
The above Rate Fetcher has rates for both GBP to USD, and USD to GBP and this works great... but you'll also notice that it has CAD to USD, but no USD to CAD conversion rates. There is some logic implemented so that you only need to store 1 way conversion rates and it will automatically invert the rate if required.
Thanks to this logic, you can run a USD to CAD conversion using the above Rate Fetcher with no problems. The full list of conversion that the above can handle is as follows:
- GBP to USD
- USD to GBP
- GBP to CAD
- CAD to GBP
- CAD to USD
- USD to CAD
#### Missing conversion rates
If no conversion rate exists at all between the 2 currencies, an `UnhandledConversionRate` Exception will be thrown.