https://github.com/secrethash/currency
The one in all Currency Library.
https://github.com/secrethash/currency
composer-package currency currency-converter free-forever
Last synced: 2 months ago
JSON representation
The one in all Currency Library.
- Host: GitHub
- URL: https://github.com/secrethash/currency
- Owner: secrethash
- License: gpl-3.0
- Created: 2018-11-20T09:07:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-15T05:31:22.000Z (over 5 years ago)
- Last Synced: 2024-12-27T14:09:25.278Z (4 months ago)
- Topics: composer-package, currency, currency-converter, free-forever
- Language: PHP
- Homepage:
- Size: 260 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
Smart Currency PHP Library utilizes the Smart Caching and Certain API providers to convert currency without having the need to pay anything. It saves your quotas of free plans of the API Providers. Smart Currency makes your currency conversions smarter with a "Self-drive" Mode. It utilizes Composer to manage it as a Package and helps you to use the library from your own private repository too.
You don't need to Pay Anything to any Currency Exchange API providers, all you need is their Free/Basic Accounts and feed the Smart Currency Library with your API Keys. It will smartly convert the amount to your desired Currency. We have built a self-drive mode to help you to cut the chase, just complete your configuration file with `"selfdrive"=>true` and run the Currency Conversion like a charm.
# Usage
Currency Conversion with Smart Currency Library is as simple as:
```php
$currency = new Secrethash\Currency\Currency;
echo $currency->convert(100, 'USD', 'INR');
```
**Follow the Steps:**
1. Require the composer autoloader:
```php
convert(100, 'USD’, 'INR’);
$currency->convertWith('exchangerate’, 100, 'INR’, 'USD’);
```
# Roadmap
- [ ] Laravel Service Provider
- [ ] Laravel Publish Config
- [ ] Publishing Configuration file
- [x] Smart Caching (via [gilbitron/PHP-SimpleCache](https://github.com/gilbitron/PHP-SimpleCache))
- [x] Self-Drive Mode
- [x] Composer Project
- [x] Extensive Providers
# Installation
Just run:
```bash
composer require secrethash/currency
```
# Function explained:
### 1. convert();
```php
convert(int $amount, string $from, string $to)
```
Three Parameters, namely - Amount, From, To
- `$amount`: *(Type: Integer)* Accepts the amount to convert.
- `$from`: *(Type: String)* Accepts String with Currency Code (ex: `USD` or `INR`)
- `$to`: *(Type: String)* Accepts String with Currency Code (ex: `USD` or `INR`)
### 2. convertWith();
```php
convertWith(string $provider, int $amount, string $from, string $to)
```
Same as `convert()` except an additional provider parameter.
- `$provider`: *(Type: String)* API Service Provider that is Available (ex: `exchangerate` or `currencylayer`).
- `$amount`: *(Type: Integer)* Amount to be converted
- `$from`: *(Type: String)* Accepts String with Currency Code (ex: `USD` or `INR`)
- `$to`: *(Type: String)* Accepts String with Currency Code (ex: `USD` or `INR`)
# License
This project is licensed under (ɔ) Copyleft GNU GPL v3.0