[Locale] partialy implemented \NumberFormatter's format() and formatC…

…urrency() methods in PHP
symfony · igorw · Jan 25, 2011 · Jan 25, 2011 · Jan 25, 2011 · Jan 25, 2011
commit d245fb8edc575173dc16aee162f60f2fc2bf5d5f
diff --git a/src/Symfony/Component/Locale/SimpleNumberFormatter.php b/src/Symfony/Component/Locale/SimpleNumberFormatter.php
@@ -19,57 +19,144 @@
  */
 class SimpleNumberFormatter implements NumberFormatterInterface
 {
-    private $formatter = null;
+    /**
+     * Default values for the en locale.
+     */
+    private $attributes = array(
+        self::FRACTION_DIGITS => 0,
+        self::GROUPING_USED   => 1,
+        self::ROUNDING_MODE   => self::ROUND_HALFEVEN
+    );
+
+    /**
+     * The supported styles to the constructor $styles argument.
+     */
+    private static $supportedStyles = array(
+        'CURRENCY' => self::CURRENCY,
+        'DECIMAL'  => self::DECIMAL
+    );
+
+    /**
+     * Supported attributes to the setAttribute() $attr argument.
+     */
+    private static $supportedAttributes = array(
+        'FRACTION_DIGITS' => self::FRACTION_DIGITS,
+        'GROUPING_USED'   => self::GROUPING_USED,
+        'ROUNDING_MODE'   => self::ROUNDING_MODE
+    );
 
     /**
-     * @see http://source.icu-project.org/repos/icu/icu/trunk/source/data/curr/en.txt
+     * The available rounding modes for setAttribute() usage with
+     * SimpleNumberFormatter::ROUNDING_MODE. SimpleNumberFormatter::ROUND_DOWN
+     * and SimpleNumberFormatter::ROUND_UP does not have a PHP only equivalent.
+     */
+    private static $roundingModes = array(
+        'ROUND_CEILING'  => self::ROUND_CEILING,
+        'ROUND_FLOOR'    => self::ROUND_FLOOR,
+        'ROUND_HALFEVEN' => self::ROUND_HALFEVEN,
+        'ROUND_HALFDOWN' => self::ROUND_HALFDOWN,
+        'ROUND_HALFUP'   => self::ROUND_HALFUP
+    );
+
+    /**
+     * The available values for setAttribute() usage with
+     * SimpleNumberFormatter::GROUPING_USED.
+     */
+    private static $groupingUsedValues = array(0, 1);
+
+    /**
+     * The mapping between \NumberFormatter rounding modes to the available
+     * modes in PHP's round() function.
+     *
+     * @see http://www.php.net/manual/en/function.round.php
+     */
+    private static $phpRoundingMap = array(
+        self::ROUND_HALFDOWN => \PHP_ROUND_HALF_DOWN,
+        self::ROUND_HALFEVEN => \PHP_ROUND_HALF_EVEN,
+        self::ROUND_HALFUP   => \PHP_ROUND_HALF_UP
+    );
+
+    /**
+     * The currencies symbols. Each array have the symbol definition in
+     * hexadecimal and the decimal digits.
+     *
+     * @see  http://source.icu-project.org/repos/icu/icu/trunk/source/data/curr/en.txt
+     * @todo Move this to Resources/data and use \ResourceBundle to load the data.
+     * @todo Search in the icu data where the currency subunits (usage of cents) are defined
      */
     private $currencies = array(
-        'ALL' => array('0x410x4c0x4c', '%.0f'),
-        'BRL' => array('0x520x24', '%.2f'),
-        'CRC' => array('0xe20x820xa1', '%.0f')
+        'ALL' => array('0x410x4c0x4c', 0),
+        'BRL' => array('0x520x24', 2),
+        'CRC' => array('0xe20x820xa1', 0)
     );
 
     /**
      * @{inheritDoc}
      */
     public function __construct($locale = 'en', $style = null, $pattern = null)
     {
+        if ('en' != $locale) {
+            throw new \InvalidArgumentException('Unsupported $locale value. Only the \'en\' locale is supported. Install the intl extension for full localization capabilities.');
+        }
+
+        if (!in_array($style, self::$supportedStyles)) {
+            throw new \InvalidArgumentException(sprintf(
+                'Unsupported $style value. The available styles are: %s. Install the intl extension for full localization capabilities.',
+                implode(', ', array_keys(self::$supportedStyles))
+            ));
+            }
+
+        if (!is_null($pattern)) {
+            throw new \InvalidArgumentException('The $pattern value must be null. Install the intl extension for full localization capabilities.');
+        }
     }
 
     /**
      * @{inheritDoc}
+     * @todo With the default rounding mode (ROUND_HALFEVEN), the currency value
+     *       seems to be correctly rounded. However, since ROUND_CEILING is
+     *       mapping to the ceil() function, the value is being returned. This
+     *       is wrong.
      */
     public function formatCurrency($value, $currency)
     {
-        $symbol = '';
-        $hexSymbol = $this->currencies[$currency][0];
-        $format    = $this->currencies[$currency][1];
-
-        $hex = explode('0x', $hexSymbol);
-        unset($hex[0]);
+        $symbol = $this->getCurrencySymbol($currency);
+        $value  = $this->round($value, $this->currencies[$currency][1]);
 
-        foreach ($hex as $h) {
-            $symbol .= chr(hexdec($h));
+        $negative = false;
+        if (0 > $value) {
+            $negative = true;
+            $value *= -1;
         }
 
-        return sprintf('%s'.$format, $symbol, $value);
+        $value = $this->formatNumber($value, $this->currencies[$currency][1]);
+
+        $ret = $symbol.$value;
+        return $negative ? '('.$ret.')' : $ret;
     }
 
     /**
      * @{inheritDoc}
      */
-    public function format($value, $type = null)
+    public function format($value, $type = self::TYPE_DEFAULT)
     {
+        if (0 > ($fractionDigits = $this->getAttribute(self::FRACTION_DIGITS))) {
+            $fractionDigits = 0;
+        }
 
+        // Rounding
+        $value = $this->round($value, $fractionDigits);
+        return $this->formatNumber($value, $fractionDigits);
     }
 
     /**
      * @{inheritDoc}
      */
     public function getAttribute($attr)
     {
-
+        if (isset($this->attributes[$attr])) {
+            return $this->attributes[$attr];
+        }
     }
 
     /**
@@ -138,10 +225,30 @@ public function parse($value, $type = self::TYPE_DOUBLE, &$position = null)
 
     /**
      * @{inheritDoc}
+     * @todo Decide between throwing an exception if ROUDING_MODE or GROUPING_USED are invalid.
+     *       In \NumberFormatter, a true is returned and the format/parse() methods have undefined values
+     *       in these cases.
+     * @throws InvalidArgumentException  When the $attr is not supported
      */
     public function setAttribute($attr, $value)
     {
+        if (!in_array($attr, self::$supportedAttributes)) {
+            throw new \InvalidArgumentException(sprintf(
+                'Unsupported $attr value. The available attributes are: %s. Install the intl extension for full localization capabilities.',
+                implode(', ', array_keys(self::$supportedAttributes))
+            ));
+        }
+
+        if (self::$supportedAttributes['ROUNDING_MODE'] == $attr && $this->isInvalidRoundingMode($value)) {
+            return false;
+        }
 
+        if (self::$supportedAttributes['GROUPING_USED'] == $attr && $this->isInvalidGroupingUsedValue($value)) {
+            return false;
+        }
+
+        $this->attributes[$attr] = $value;
+        return true;
     }
 
     /**
@@ -167,4 +274,91 @@ public function setTextAttribute($attr, $value)
     {
 
    }
+
+    /**
+     * Returns the currency symbol.
+     *
+     * @param  string   $currency   The 3-letter ISO 4217 currency code indicating the currency to use
+     * @return string               The currency symbol
+     */
+    private function getCurrencySymbol($currency)
+    {
+        $symbol = '';
+        $hexSymbol = $this->currencies[$currency][0];
+        $hex = explode('0x', $hexSymbol);
+        unset($hex[0]);
+
+        foreach ($hex as $h) {
+            $symbol .= chr(hexdec($h));
+        }
+
+        return $symbol;
+    }
+
+    /**
+     * Rounds a value.
+     *
+     * @param  numeric   $value      The value to round
+     * @param  int       $precision  The number of decimal digits to round to
+     * @return numeric               The rounded value
+     */
+    private function round($value, $precision)
+    {
+        switch ($this->getAttribute(self::ROUNDING_MODE)):
+            case self::ROUND_CEILING:
+                $value = ceil($value);
+                break;
+            case self::ROUND_FLOOR:
+                $value = floor($value);
+                break;
+            default:
+                $roundingMode = self::$phpRoundingMap[$this->getAttribute(self::ROUNDING_MODE)];
+                $value = round($value, $precision, $roundingMode);
+                break;
+            endswitch;
+
+        return $value;
+    }
+
+    /**
+     * Formats a number.
+     *
+     * @param  numeric   $value      The numeric value to format
+     * @param  int       $precision  The number of decimal digits to use
+     * @return string                The formatted number
+     */
+    private function formatNumber($value, $precision)
+    {
+        return number_format($value, $precision, '.', $this->getAttribute(self::GROUPING_USED) ? ',' : '');
+    }
+
+    /**
+     * Check if the rounding mode is invalid.
+     *
+     * @param  int    $value  The rounding mode value to check
+     * @return bool           true if the rounding mode is invalid, false otherwise
+     */
+    private function isInvalidRoundingMode($value)
+    {
+        if (in_array($value, self::$roundingModes, true)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if the grouping value is invalid.
+     *
+     * @param  int    $value  The grouping value to check
+     * @return bool           true if the grouping value is invalid, false otherwise
+     */
+    private function isInvalidGroupingUsedValue($value)
+    {
+        if (in_array($value, self::$groupingUsedValues, true)) {
+            return false;
+        }
+
+        return true;
+    }
 }