Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valicm/commerce_exchanger
Currency exchange rates module for Drupal Commerce 2.
https://github.com/valicm/commerce_exchanger
currency-exchange-rates drupal drupal-commerce drupal8-module exchange-rates
Last synced: 5 days ago
JSON representation
Currency exchange rates module for Drupal Commerce 2.
- Host: GitHub
- URL: https://github.com/valicm/commerce_exchanger
- Owner: valicm
- Created: 2019-09-22T15:21:52.000Z (over 5 years ago)
- Default Branch: 2.0.x
- Last Pushed: 2024-09-05T10:19:14.000Z (4 months ago)
- Last Synced: 2024-12-23T06:19:19.803Z (11 days ago)
- Topics: currency-exchange-rates, drupal, drupal-commerce, drupal8-module, exchange-rates
- Language: PHP
- Homepage: https://www.drupal.org/project/commerce_exchanger
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CONTENTS OF THIS FILE
---------------------
* Introduction
* Requirements
* Installation
* Configuration
* Custom exchange rates
* Plugin system
* Maintainers
INTRODUCTION
------------
Currency exchange rates module for Drupal Commerce 2.
Features
1. Manual or remote exchange rates sources.
2. Built for Commerce 2
3. Exchange rates stored in dedicated database table.
4. Provide default price conversion calculator service.
5. Plugin based system.
6. Integration with Commerce Currency Resolver module
7. Store rates in historical table per each day.
Builtin exchange rates plugins are:
1. Manual plugin
2. TransferWise
2. Fixer (free and paid)
3. Currencylayer (free and paid)
3. European Central Bank
REQUIREMENTS
------------
This module requires Drupal Commerce 2 and it's submodule price.
INSTALLATION
------------
Install the Commerce Exchanger module as you would normally install
any Drupal contrib module.
Visit https://www.drupal.org/node/1897420 for further information.
CONFIGURATION
--------------
1. Navigate to Administration > Extend and enable the Commerce Exchanger
module.
2. Navigate to Home > Administration > Commerce > Configuration
> Exchange rates.
CUSTOM EXCHANGE RATES
--------------
For any provider (manual or remote) you can trough UI
overwrite any ratio for any currency. Once you enable manually
entered value, this one is going to be ignored from regular sync.
If you want to directly fill database table, skipping default cron,
you can use service `commerce_exchanger.manager` and method
`\Drupal\commerce_exchanger\ExchangerManager::setLatest`.
Even it's advisable that you write your own plugin if you need additional
customization.
PLUGIN SYSTEM
--------------
See examples of implementation for external providers inside plugin namespace.
`\Drupal\commerce_exchanger\Plugin\Commerce\ExchangerProvider\`
See `\Drupal\commerce_exchanger\Annotation\CommerceExchangerProvider`
for available properties on CommerceExchangerProvider annotation plugin type.
In most cases it would be enough to make proper annotation type
and implement two functions inside your plugin:
`ExchangerProviderRemoteInterface::apiUrl`
`ExchangerProviderRemoteInterface::getRemoteData`
Note that function `getRemoteData()` should return array keyed as examples
below. If you follow that format, you don't need to implement anything more
in your plugin.
```
['HRK' => '1.3', 'USD' => '1.666']
```
or
```
['base' => 'USD', 'rates' => ['HRK' => '1.3', 'EUR' => '1.666']]
```
Either format will work.
PLUGIN EXAMPLES
--------------
https://www.drupal.org/project/commerce_exchanger_hnb
https://www.drupal.org/project/commerce_exchanger_nbu
PLUGIN ANNOTATION
--------------
All options `\Drupal\commerce_exchanger\Annotation\CommerceExchangerProvider`
Some specifics to single out:
**base_currency**
When external source locked to single currency source (as ECB).
If you use this annotation, enterprise mode is not available,
and exchange rates always calculated as cross conversion
between non default currencies.
**transform_rates**
Usually most of the exchange rate providers are giving ratio based
on base currency. Like 1 EUR = 1.116 USD, and you get data in json as
```
[
{
"rate": 1.166,
"source": "EUR",
"target": "USD",
"time": "2018-08-31T10:43:31+0000"
}
]
```
But some of them are doing reverse.
```
[
{
"rate": 0.84,
"source": "EUR",
"target": "USD",
"time": "2018-08-31T10:43:31+0000"
}
]
```
In these cases you need us `transform_mode = TRUE` annotation on your plugin.
MAINTAINERS
-----------
The 8.x-1.x branch was created by:
* https://www.drupal.org/u/valic