You are here

Home » API reference » Currency 8.3 » Intl.php

class Intl in Currency 8.3

Formats amounts using PHP's Intl extension.

Plugin annotation


@CurrencyAmountFormatter(
  description = @Translation("Formats amounts using locales' Unicode number patterns for increased accuracy."),
  id = "currency_intl",
  label = @Translation("Unicode number patterns")
)

Hierarchy

Expanded class hierarchy of Intl

1 file declares its use of Intl
IntlTest.php in modules/currency_intl/tests/src/Unit/Plugin/Currency/AmountFormatter/IntlTest.php

File

modules/currency_intl/src/Plugin/Currency/AmountFormatter/Intl.php, line 22

Namespace

Drupal\currency_intl\Plugin\Currency\AmountFormatter
View source 
class Intl extends PluginBase implements AmountFormatterInterface, ContainerFactoryPluginInterface {

  /**
   * The locale delegator.
   *
   * @var \Drupal\currency\LocaleResolver
   */
  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\currency\LocaleResolverInterface $locale_delegator
   *   The locale delegator.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, LocaleResolverInterface $locale_delegator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->localeDelegator = $locale_delegator;
  }

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

  /**
   * {@inheritdoc}
   */
  public function formatAmount(CurrencyInterface $currency, $amount, $language_type = LanguageInterface::TYPE_CONTENT) {
    $currency_locale = $this->localeDelegator
      ->resolveCurrencyLocale();
    $decimal_position = strpos($amount, '.');
    $number_of_decimals = $decimal_position !== FALSE ? strlen(substr($amount, $decimal_position + 1)) : 0;
    $formatter = new \NumberFormatter($currency_locale
      ->getLocale(), \NumberFormatter::PATTERN_DECIMAL, $currency_locale
      ->getPattern());
    $formatter
      ->setAttribute(\NumberFormatter::FRACTION_DIGITS, $number_of_decimals);
    $formatter
      ->setSymbol(\NumberFormatter::DECIMAL_SEPARATOR_SYMBOL, $currency_locale
      ->getDecimalSeparator());
    $formatter
      ->setSymbol(\NumberFormatter::MONETARY_SEPARATOR_SYMBOL, $currency_locale
      ->getDecimalSeparator());
    $formatter
      ->setSymbol(\NumberFormatter::GROUPING_SEPARATOR_SYMBOL, $currency_locale
      ->getGroupingSeparator());
    $formatter
      ->setSymbol(\NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL, $currency_locale
      ->getGroupingSeparator());
    $formatter
      ->setSymbol(\NumberFormatter::CURRENCY_SYMBOL, $currency
      ->getSign());
    $formatter
      ->setSymbol(\NumberFormatter::INTL_CURRENCY_SYMBOL, $currency
      ->getCurrencyCode());
    return $formatted = $formatter
      ->format($amount);
  }

}

Members

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