vendor/florianv/exchanger/src/Service/SupportsHistoricalQueries.php line 39

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\Service;
  16. use Exchanger\Contract\ExchangeRate as ExchangeRateContract;
  17. use Exchanger\Contract\ExchangeRateQuery as ExchangeRateQueryContract;
  18. use Exchanger\Contract\HistoricalExchangeRateQuery as HistoricalExchangeRateQueryContract;
  19. use Exchanger\Exception\UnsupportedCurrencyPairException;
  21. /**
  22.  * Trait to implement to add historical service support.
  23.  *
  24.  * @author Florian Voutzinos <florian@voutzinos.com>
  25.  */
  26. trait SupportsHistoricalQueries
  27. {
  28.     /**
  29.      * {@inheritdoc}
  30.      */
  31.     public function getExchangeRate(ExchangeRateQueryContract $exchangeQuery): ExchangeRateContract
  32.     {
  33.         $currencyPair = $exchangeQuery->getCurrencyPair();
  35.         if ($exchangeQuery instanceof HistoricalExchangeRateQueryContract) {
  36.             if ($rate = $this->getHistoricalExchangeRate($exchangeQuery)) {
  37.                 return $rate;
  38.             }
  39.         } elseif ($rate = $this->getLatestExchangeRate($exchangeQuery)) {
  40.             return $rate;
  41.         }
  43.         throw new UnsupportedCurrencyPairException($currencyPair, $this);
  44.     }
  46.     /**
  47.      * Gets the latest rate.
  48.      *
  49.      * @param ExchangeRateQueryContract $exchangeQuery
  50.      *
  51.      * @return ExchangeRateContract
  52.      */
  53.     abstract protected function getLatestExchangeRate(ExchangeRateQueryContract $exchangeQuery): ExchangeRateContract;
  55.     /**
  56.      * Gets an historical rate.
  57.      *
  58.      * @param HistoricalExchangeRateQueryContract $exchangeQuery
  59.      *
  60.      * @return ExchangeRateContract
  61.      */
  62.     abstract protected function getHistoricalExchangeRate(HistoricalExchangeRateQueryContract $exchangeQuery): ExchangeRateContract;
  63. }