vendor/florianv/exchanger/src/Exchanger.php line 102

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Exchanger.
  7.  *
  8.  * (c) Florian Voutzinos <florian@voutzinos.com>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Exchanger;
  16. use Exchanger\Contract\ExchangeRateProvider as ExchangeRateProviderContract;
  17. use Exchanger\Contract\ExchangeRateQuery as ExchangeRateQueryContract;
  18. use Exchanger\Contract\ExchangeRateService as ExchangeRateServiceContract;
  19. use Exchanger\Exception\CacheException;
  20. use Exchanger\Exception\UnsupportedExchangeQueryException;
  21. use Exchanger\Contract\ExchangeRate as ExchangeRateContract;
  22. use Psr\SimpleCache\CacheInterface;
  24. /**
  25.  * Default implementation of the exchange rate provider with PSR-6 caching support.
  26.  *
  27.  * @author Florian Voutzinos <florian@voutzinos.com>
  28.  */
  29. final class Exchanger implements ExchangeRateProviderContract
  30. {
  31.     /**
  32.      * The service.
  33.      *
  34.      * @var ExchangeRateServiceContract
  35.      */
  36.     private $service;
  38.     /**
  39.      * The cache item pool.
  40.      *
  41.      * @var CacheInterface
  42.      */
  43.     private $cache;
  45.     /**
  46.      * The options.
  47.      *
  48.      * @var array
  49.      */
  50.     private $options;
  52.     /**
  53.      * Constructor.
  54.      *
  55.      * @param ExchangeRateServiceContract $service
  56.      * @param CacheInterface|null         $cache
  57.      * @param array                       $options
  58.      */
  59.     public function __construct(ExchangeRateServiceContract $service, CacheInterface $cache = null, array $options = [])
  60.     {
  61.         $this->service = $service;
  62.         $this->cache = $cache;
  63.         $this->options = $options;
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function getExchangeRate(ExchangeRateQueryContract $exchangeQuery): ExchangeRateContract
  70.     {
  71.         $currencyPair = $exchangeQuery->getCurrencyPair();
  73.         if ($currencyPair->isIdentical()) {
  74.             return new ExchangeRate($currencyPair, 1, new \DateTime(), 'null');
  75.         }
  77.         if (!$this->service->supportQuery($exchangeQuery)) {
  78.             throw new UnsupportedExchangeQueryException($exchangeQuery, $this->service);
  79.         }
  81.         if (null === $this->cache || false === $exchangeQuery->getOption('cache')) {
  82.             return $this->service->getExchangeRate($exchangeQuery);
  83.         }
  85.         $cacheKeyPrefix = isset($this->options['cache_key_prefix']) ? $this->options['cache_key_prefix'] : '';
  86.         $cacheKeyPrefix = $exchangeQuery->getOption('cache_key_prefix', $cacheKeyPrefix);
  88.         // Replace characters reserved in PSR-6
  89.         $cacheKeyPrefix = preg_replace('#[\{\}\(\)/\\\@\:]#', '-', $cacheKeyPrefix);
  91.         $cacheKey = $cacheKeyPrefix.sha1(serialize($exchangeQuery));
  92.         if (\strlen($cacheKey) > 64) {
  93.             throw new CacheException("Cache key length exceeds 64 characters ('$cacheKey'). This violates PSR-6 standard");
  94.         }
  96.         $item = $this->cache->get($cacheKey);
  98.         if (null !== $item && $item instanceof ExchangeRateContract) {
  99.             return $item;
  100.         }
  102.         $rate = $this->service->getExchangeRate($exchangeQuery);
  103.         $ttl = $exchangeQuery->getOption('cache_ttl', isset($this->options['cache_ttl']) ? $this->options['cache_ttl'] : null);
  105.         $this->cache->set($cacheKey, $rate, $ttl);
  107.         return $rate;
  108.     }
  109. }