class ExchangeRateProviderDecorator in Currency 8.3

Provides an exchange rate provider decorator.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\currency\Plugin\Currency\ExchangeRateProvider\ExchangeRateProviderDecorator implements ExchangeRateProviderInterface

1 file declares its use of ExchangeRateProviderDecorator

ExchangeRateProviderDecoratorTest.php in tests/src/Unit/Plugin/Currency/ExchangeRateProvider/ExchangeRateProviderDecoratorTest.php

File

src/Plugin/Currency/ExchangeRateProvider/ExchangeRateProviderDecorator.php, line 12

Namespace

Drupal\currency\Plugin\Currency\ExchangeRateProvider

class ExchangeRateProviderDecorator extends PluginBase implements ExchangeRateProviderInterface {

  /**
   * The decorated exchange rate provider
   *
   * @var \Commercie\CurrencyExchange\ExchangeRateProviderInterface
   */
  protected $exchangeRateProvider;

  /**
   * Constructs a new instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Commercie\CurrencyExchange\ExchangeRateProviderInterface
   *   The decorated exchange rate provider.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, GenericExchangeRateProviderInterface $exchange_rate_provider) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->exchangeRateProvider = $exchange_rate_provider;
  }

  /**
   * {@inheritdoc}
   */
  public function load($source_currency_code, $destination_currency_code) {
    $exchange_rate = $this->exchangeRateProvider
      ->load($source_currency_code, $destination_currency_code);
    return ExchangeRate::createFromExchangeRate($exchange_rate, $this
      ->getPluginId());
  }

  /**
   * {@inheritdoc}
   */
  public function loadMultiple(array $currency_codes) {
    $exchange_rates = [];
    foreach ($this->exchangeRateProvider
      ->loadMultiple($currency_codes) as $source_currency_code => $destinations) {
      foreach ($destinations as $destination_currency_code => $exchange_rate) {
        $exchange_rates[$source_currency_code][$destination_currency_code] = ExchangeRate::createFromExchangeRate($exchange_rate, $this
          ->getPluginId());
      }
    }
    return $exchange_rates;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ExchangeRateProviderDecorator::$exchangeRateProvider	protected	property	The decorated exchange rate provider
ExchangeRateProviderDecorator::load	public	function	Overrides ExchangeRateProviderInterface::load
ExchangeRateProviderDecorator::loadMultiple	public	function	Overrides ExchangeRateProviderInterface::loadMultiple
ExchangeRateProviderDecorator::__construct	public	function	Constructs a new instance. Overrides PluginBase::__construct	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.