class Basic in Currency 8.3

Formats amounts using string translation and number_format().

Plugin annotation

@CurrencyAmountFormatter(
  description = @Translation("Formats amounts using a translatable string."),
  id = "currency_basic",
  label = @Translation("Basic")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\currency\Plugin\Currency\AmountFormatter\Basic implements ContainerFactoryPluginInterface, AmountFormatterInterface

1 file declares its use of Basic

BasicTest.php in tests/src/Unit/Plugin/Currency/AmountFormatter/BasicTest.php

File

src/Plugin/Currency/AmountFormatter/Basic.php, line 22

Namespace

Drupal\currency\Plugin\Currency\AmountFormatter

class Basic extends PluginBase implements AmountFormatterInterface, ContainerFactoryPluginInterface {

  /**
   * The locale delegator.
   *
   * @var \Drupal\currency\LocaleResolverInterface
   */
  protected $localeDelegator;

  /**
   * Constructs a new instance.
   *
   * @param mixed[] $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 \Drupal\Core\StringTranslation\TranslationInterface $translation_manager
   *   The translation manager.
   * @param \Drupal\currency\LocaleResolverInterface $locale_delegator
   *   The locale delegator.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, TranslationInterface $translation_manager, LocaleResolverInterface $locale_delegator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->localeDelegator = $locale_delegator;
    $this->stringTranslation = $translation_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $container
      ->get('currency.locale_resolver'));
  }

  /**
   * {@inheritdoc}
   */
  public function formatAmount(CurrencyInterface $currency, $amount, $language_type = LanguageInterface::TYPE_CONTENT) {

    // Compute the number of decimals, so we can format all of them and no less
    // or more.
    $decimals = strlen($amount) - strpos($amount, '.') - 1;
    $currency_locale = $this->localeDelegator
      ->resolveCurrencyLocale();
    $formatted_amount = number_format($amount, $decimals, $currency_locale
      ->getDecimalSeparator(), $currency_locale
      ->getGroupingSeparator());
    $arguments = array(
      '@currency_code' => $currency
        ->getCurrencyCode(),
      '@currency_sign' => $currency
        ->getSign(),
      '@amount' => $formatted_amount,
    );
    return $this
      ->t('@currency_code @amount', $arguments);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Basic::$localeDelegator	protected	property	The locale delegator.
Basic::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Basic::formatAmount	public	function	Formats an amount. Overrides AmountFormatterInterface::formatAmount
Basic::__construct	public	function	Constructs a new instance. Overrides PluginBase::__construct
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
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.