Files
InvoiceShelf/app/Providers/DriverRegistryProvider.php
Darko Gjorgjijoski e44657bf7e feat(exchange-rate): make providers extendible via module Registry
Exchange rate providers are now pluggable via the module Registry. The four built-in drivers (currency_converter, currency_freak, currency_layer, open_exchange_rate) move from a static config array into App\\Providers\\DriverRegistryProvider, which calls Registry::registerExchangeRateDriver() for each during app boot with metadata the frontend needs: label (i18n key), website (help-text URL), and config_fields (schema for driver-specific driver_config JSON).

The Currency Converter's server-type selector and dedicated URL field — previously hardcoded in ExchangeRateProviderModal.vue — are now just another config_fields entry with a visible_when rule that shows the URL input only when type=DEDICATED. Any module that wants to ship a custom driver gets the same treatment for free: declare config_fields in the registration, and the host app's modal renders them automatically.

ExchangeRateDriverFactory::make() falls back to Registry::driverMeta() when a name isn't in the local built-in map, and availableDrivers() merges both sources. ConfigController handles the exchange_rate_drivers key specially by mapping Registry::allDrivers('exchange_rate') to enriched option objects, so the config-file route still works for every other key. The static exchange_rate_drivers + currency_converter_servers arrays in config/invoiceshelf.php are deleted.

Unit tests cover the new Registry::register/flushDrivers, the factory merging built-ins with Registry-contributed drivers, and the factory rejecting unknown names. A feature test exercises the end-to-end /api/v1/config?key=exchange_rate_drivers response shape.

NOTE: this commit depends on invoiceshelf/modules package commit e44d951 which adds the Registry driver API. The package needs to be released and pinned in composer.json before a fresh composer install on this commit will work.
2026-04-11 04:00:00 +02:00

66 lines
2.4 KiB
PHP

<?php
namespace App\Providers;
use App\Services\ExchangeRate\CurrencyConverterDriver;
use App\Services\ExchangeRate\CurrencyFreakDriver;
use App\Services\ExchangeRate\CurrencyLayerDriver;
use App\Services\ExchangeRate\OpenExchangeRateDriver;
use Illuminate\Support\ServiceProvider;
use InvoiceShelf\Modules\Registry;
class DriverRegistryProvider extends ServiceProvider
{
public function boot(): void
{
$this->registerExchangeRateDrivers();
}
protected function registerExchangeRateDrivers(): void
{
Registry::registerExchangeRateDriver('currency_converter', [
'class' => CurrencyConverterDriver::class,
'label' => 'settings.exchange_rate.currency_converter',
'website' => 'https://www.currencyconverterapi.com',
'config_fields' => [
[
'key' => 'type',
'type' => 'select',
'label' => 'settings.exchange_rate.server',
'options' => [
['label' => 'settings.preferences.premium', 'value' => 'PREMIUM'],
['label' => 'settings.preferences.prepaid', 'value' => 'PREPAID'],
['label' => 'settings.preferences.free', 'value' => 'FREE'],
['label' => 'settings.preferences.dedicated', 'value' => 'DEDICATED'],
],
'default' => 'FREE',
],
[
'key' => 'url',
'type' => 'text',
'label' => 'settings.exchange_rate.url',
'visible_when' => ['type' => 'DEDICATED'],
],
],
]);
Registry::registerExchangeRateDriver('currency_freak', [
'class' => CurrencyFreakDriver::class,
'label' => 'settings.exchange_rate.currency_freak',
'website' => 'https://currencyfreaks.com',
]);
Registry::registerExchangeRateDriver('currency_layer', [
'class' => CurrencyLayerDriver::class,
'label' => 'settings.exchange_rate.currency_layer',
'website' => 'https://currencylayer.com',
]);
Registry::registerExchangeRateDriver('open_exchange_rate', [
'class' => OpenExchangeRateDriver::class,
'label' => 'settings.exchange_rate.open_exchange_rate',
'website' => 'https://openexchangerates.org',
]);
}
}