class CurrencyExchangeRateProvider in Currency 8.3

Defines a currency exchange rate provider plugin definition.

If a plugin exposes configuration, it SHOULD also provide a configuration schema for this configuration of which the name is `plugin.plugin_configuration.currency_exchange_rate_provider.[plugin_id]`, where `[plugin_id]` is the plugin's ID.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\currency\Annotation\CurrencyExchangeRateProvider

1 file declares its use of CurrencyExchangeRateProvider

ExchangeRateProviderManager.php in src/Plugin/Currency/ExchangeRateProvider/ExchangeRateProviderManager.php

2 classes are annotated with CurrencyExchangeRateProvider

FixedRates in src/Plugin/Currency/ExchangeRateProvider/FixedRates.php

Provides manually entered exchange rates.

HistoricalRates in src/Plugin/Currency/ExchangeRateProvider/HistoricalRates.php

Provides historical exchange rates.

File

src/Annotation/CurrencyExchangeRateProvider.php, line 17

Namespace

Drupal\currency\Annotation

class CurrencyExchangeRateProvider extends Plugin {

  /**
   * The translated human-readable plugin name (optional).
   *
   * @var string
   */
  public $description = '';

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The translated human-readable plugin name.
   *
   * @var string
   */
  public $label;

  /**
   * The name of the class that provides plugin operations.
   *
   * The class must implement \Drupal\plugin\PluginOperationsProviderInterface.
   *
   * @var string
   */
  public $operations_provider;

}

Members

Name	Modifiers	Type	Description	Overrides
CurrencyExchangeRateProvider::$description	public	property	The translated human-readable plugin name (optional).
CurrencyExchangeRateProvider::$id	public	property	The plugin ID.
CurrencyExchangeRateProvider::$label	public	property	The translated human-readable plugin name.
CurrencyExchangeRateProvider::$operations_provider	public	property	The name of the class that provides plugin operations.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2