You are here

Home » API reference » Currency 7.2 » DecimalFormatter.php

class DecimalFormatter in Currency 7.2

Formats a decimal according CLDR number pattern guidelines.

Hierarchy

Expanded class hierarchy of DecimalFormatter

2 files declare their use of DecimalFormatter
DecimalFormatterTest.php in currency/vendor/bartfeenstra/cldr/src/BartFeenstra/Tests/CLDR/DecimalFormatterTest.php
Contains class \BartFeenstra\Tests\CLDR\DecimalFormatterTest.
TestDecimalFormatter.php in currency/vendor/bartfeenstra/cldr/src/BartFeenstra/Tests/CLDR/TestDecimalFormatter.php
Contains class \BartFeenstra\CLDR\TestDecimalFormatter.

File

currency/vendor/bartfeenstra/cldr/src/BartFeenstra/CLDR/DecimalFormatter.php, line 13
Contains class \BartFeenstra\CLDR\IntegerFormatter.

Namespace

BartFeenstra\CLDR
View source 
class DecimalFormatter extends IntegerFormatter {

  /**
   * Indicates a major pattern fragment.
   *
   * @var integer
   */
  const MAJOR = 0;

  /**
   * Indicates a minor pattern fragment.
   *
   * @var integer
   */
  const MINOR = 1;

  /**
   * The decimal separator's symbol.
   *
   * @var string
   */
  const SYMBOL_SPECIAL_DECIMAL_SEPARATOR = '.';

  /**
   * Overrides parent::__construct().
   */
  function __construct($pattern, array $symbol_replacements = array()) {
    $this->pattern = $pattern;
    $this->symbol_replacements = $symbol_replacements;
    $symbols = $this
      ->patternSymbolsSplit($this
      ->patternSymbols($pattern), self::SYMBOL_PATTERN_SEPARATOR, TRUE);

    // If there is no negative pattern, add a default.
    if ($symbols[self::NEGATIVE] === FALSE) {
      $pattern .= ';-' . $pattern;
      $symbols = $this
        ->patternSymbolsSplit($this
        ->patternSymbols($pattern), self::SYMBOL_PATTERN_SEPARATOR, TRUE);
    }
    foreach ($symbols as $sign_symbols) {
      if (empty($sign_symbols)) {
        throw new \InvalidArgumentException('Empty number pattern.');
      }
    }
    $this->symbols = array(
      $this
        ->patternSymbolsSplit($symbols[self::POSITIVE], self::SYMBOL_SPECIAL_DECIMAL_SEPARATOR),
      $this
        ->patternSymbolsSplit($symbols[self::NEGATIVE], self::SYMBOL_SPECIAL_DECIMAL_SEPARATOR),
    );
  }

  /**
   * Overrides parent::format().
   *
   * A decimal is formatted by splitting it into two integers: the major
   * and minor unit. They are formatted individually and then joined together.
   *
   * @param float|string $number
   */
  public function format($number) {
    if ((double) $number != $number) {
      throw new \InvalidArgumentException('Number has no valid float value.');
    }
    $sign = (int) ($number < 0);

    // Split the number in major and minor units, and make sure there is a
    // minor unit at all.
    $number = explode('.', abs($number));
    $number += array(
      self::MINOR => '',
    );
    $digits = array(
      str_split($number[self::MAJOR]),
      strlen($number[self::MINOR]) ? str_split($number[self::MINOR]) : array(),
    );
    $symbols = $this
      ->cloneNumberPatternSymbols($this->symbols[$sign]);
    $this
      ->process($symbols[$sign][self::MAJOR], $digits[self::MAJOR]);

    // Integer formatting defaults from right to left, but minor units should
    // be formatted from left to right, so reverse all data and results.
    $symbols_minor = array_reverse($symbols[$sign][self::MINOR]);
    $this
      ->process($symbols_minor, array_reverse($digits[self::MINOR]));
    foreach ($symbols[$sign][self::MINOR] as $symbol) {
      if (!is_null($symbol->replacement)) {
        $symbol->replacement = strrev($symbol->replacement);
      }
    }

    // Prepare the output string.
    $output = array(
      self::MAJOR => '',
      self::MINOR => '',
    );
    foreach ($symbols[$sign] as $fragment => $fragment_symbols) {
      $this
        ->replacePlaceholders($fragment_symbols);
      foreach ($fragment_symbols as $symbol) {
        $output[$fragment] .= !is_null($symbol->replacement) ? $symbol->replacement : $symbol->symbol;
      }
    }
    return $output[self::MAJOR] . $this
      ->getReplacement(self::SYMBOL_SPECIAL_DECIMAL_SEPARATOR) . $output[self::MINOR];
  }

  /**
   * Clones this formatter's NumberPatternSymbol objects.
   *
   * @return array
   *  An array identical to $this->symbols.
   */
  function cloneNumberPatternSymbols() {
    $clone = array(
      self::POSITIVE => array(
        self::MAJOR => array(),
        self::MINOR => array(),
      ),
      self::NEGATIVE => array(
        self::MAJOR => array(),
        self::MINOR => array(),
      ),
    );
    foreach ($this->symbols as $sign => $sign_symbols) {
      foreach ($sign_symbols as $fragment => $fragment_symbols) {
        foreach ($fragment_symbols as $symbol) {
          $clone[$sign][$fragment][] = clone $symbol;
        }
      }
    }
    return $clone;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DecimalFormatter::cloneNumberPatternSymbols function Clones this formatter's NumberPatternSymbol objects. Overrides IntegerFormatter::cloneNumberPatternSymbols
DecimalFormatter::format public function Overrides parent::format(). Overrides IntegerFormatter::format 1
DecimalFormatter::MAJOR constant Indicates a major pattern fragment.
DecimalFormatter::MINOR constant Indicates a minor pattern fragment.
DecimalFormatter::SYMBOL_SPECIAL_DECIMAL_SEPARATOR constant The decimal separator's symbol.
DecimalFormatter::__construct function Overrides parent::__construct(). Overrides IntegerFormatter::__construct
IntegerFormatter::$pattern public property The original pattern.
IntegerFormatter::$symbols protected property This pattern's symbols.
IntegerFormatter::$symbol_replacements public property Replacements for occurrences of the self::SYMBOL_SPECIAL_* constants in $this->pattern.
IntegerFormatter::getReplacement function Gets a replacement symbol for a placeholder.
IntegerFormatter::NEGATIVE constant Indicates a negative pattern.
IntegerFormatter::patternSymbols function Converts a number pattern to an array of NumberPatternSymbol objects.
IntegerFormatter::patternSymbolsSplit protected function Splits a pattern into two fragments.
IntegerFormatter::PCRE_META_CHARACTERS constant PCRE meta characters.
IntegerFormatter::POSITIVE constant Indicates a positive pattern.
IntegerFormatter::process protected function Process the pattern's symbols using a number.
IntegerFormatter::replacePlaceholders function Replaces placeholders. 2
IntegerFormatter::strrev static function Reverses a string in a unicode-safe way.
IntegerFormatter::str_split static function Splits a string in a unicode-safe way.
IntegerFormatter::symbolIsSpecial function Checks if a symbol is a special.
IntegerFormatter::SYMBOL_DIGIT constant A digit.
IntegerFormatter::SYMBOL_DIGIT_OPTIONAL constant An optional digit.
IntegerFormatter::SYMBOL_ESCAPE constant An escape character.
IntegerFormatter::SYMBOL_PATTERN_SEPARATOR constant The pattern separator.
IntegerFormatter::SYMBOL_SPECIAL_GROUPING_SEPARATOR constant The grouping separator's symbol.
IntegerFormatter::SYMBOL_SPECIAL_INFINITY constant Infinity's symbol.
IntegerFormatter::SYMBOL_SPECIAL_MINUS constant The minus sign's symbol.
IntegerFormatter::SYMBOL_SPECIAL_NAN constant "not a number"'s symbol.
IntegerFormatter::SYMBOL_SPECIAL_PLUS constant The plus sign's symbol.
IntegerFormatter::__clone function Implements __clone().