https://github.com/gocanto/converter

Immutable PHP currency converter that's data-agnostic.
https://github.com/gocanto/converter

agnostic converter currencies immutable library php

Last synced: about 2 months ago
JSON representation

Immutable PHP currency converter that's data-agnostic.

• Host: GitHub
• URL: https://github.com/gocanto/converter
• Owner: gocanto
• License: mit
• Created: 2019-06-07T06:31:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-11T06:28:41.000Z (over 5 years ago)
• Last Synced: 2024-07-25T09:28:10.390Z (about 2 months ago)
• Topics: agnostic, converter, currencies, immutable, library, php
• Language: PHP
• Homepage:
• Size: 68.4 KB
• Stars: 77
• Watchers: 6
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## About it







The converter library is a `immutable` drop in currencies converter that's data-agnostic.. 

In order for it to work, you will have to pass your repository data look up to pull in a valid information to operate on. This repository has to implement the interface `CurrenciesRepositoryInterface` [shipped](https://github.com/gocanto/converter/blob/master/src/Interfaces/CurrenciesRepositoryInterface.php) with the library  

## Installation

This library uses [Composer](https://getcomposer.org) to manage its dependencies. So, before using it, make sure you have it installed in your machine. 

Once you have done this, you will be able to pull this library in by typing the following command in your terminal.

```

composer require gocanto/converter

```

    

## Data layer implementation

First of all, you will have to create a repository to query either your database or any other data resources where you keep your application currencies information. [see example](https://github.com/gocanto/converter/blob/master/examples/CurrenciesRepositoryExample.php)

Second of all, you will have to new up the converter passing an instance of the mentioned interface repository implementation. Like so:

```php

use Gocanto\Converter\Examples\CurrenciesRepositoryExample;

use Gocanto\Converter\Converter;

$repository = new CurrenciesRepositoryExample;

$converter = new Converter($repository);

```

> Note: You can bind this interface within your app service container to have automatic dependencies injection resolution.

Lastly, you just need to invoke the required methods within the converter object to set the proper values for a given currency conversion (currency from, currency to). Like so:

```php

use Gocanto\Converter\RoundedNumber;

$conversion = $converter

    ->withAmount(RoundedNumber::make(10))

    ->withCurrency('SGD')

    ->convertTo('USD');

```

> This operation will return a Currency Conversion object that holds all the related operations info 

## Contributing

Please feel free to fork this package and contribute by submitting a pull request to enhance its functionalities.

## License

The MIT License (MIT). Please see [License File](https://github.com/gocanto/converter/blob/master/LICENSE.md) for more information.

## How can I thank you?

Why not star the github repo and share the link for this repository on Twitter?

Don't forget to [follow me on twitter](https://twitter.com/gocanto)!

Thanks!

Gustavo Ocanto.