number_to_currency implemented

Author: lonnieezell

README.md

@@ -61,7 +61,10 @@ We are not looking for out-of-scope contributions, only those that would be cons
 Please read the *Contributing to CodeIgniter* section in the user guide
 
 ## Server Requirements
-PHP version 7 or higher is required. 
+PHP version 7 or higher is required, with the following extensions installed: 
+
+- intl
+
 
 ## Running CodeIgniter Tests
 Information on running CodeIgniter test suite can be found in the [README.md](tests/README.md) file in the tests directory.

system/Helpers/number_helper.php

@@ -152,8 +152,32 @@ function number_to_amount($num, int $precision, string $locale = null)
 
 //--------------------------------------------------------------------
 
+if (! function_exists('number_to_currency'))
+{
+    function number_to_currency($num, string $currency = null, string $locale = null)
+    {
+        return format_number($num, 1, $locale, [
+            'type' => NumberFormatter::CURRENCY,
+            'currency' => $currency
+        ]);
+    }
+}
+
+//--------------------------------------------------------------------
+
 if (! function_exists('format_number'))
 {
+    /**
+     * A general purpose, locale-aware, number_format method.
+     * Used by all of the functions of the number_helper.
+     *
+     * @param             $num
+     * @param int         $precision
+     * @param string|null $locale
+     * @param array       $options
+     *
+     * @return string
+     */
     function format_number($num, int $precision = 1, string $locale = null, array $options=[])
     {
         // Locale is either passed in here, negotiated with client, or grabbed from our config file.
@@ -169,10 +193,17 @@ function format_number($num, int $precision = 1, string $locale = null, array $o
         $pattern = '#,##0.'. str_repeat('#', $precision);
 
         $formatter = new NumberFormatter($locale, $type);
-        $formatter->setPattern($pattern);
 
         // Try to format it per the locale
-        $output = $formatter->format($num);
+        if ($type == NumberFormatter::CURRENCY)
+        {
+            $output = $formatter->formatCurrency($num, $options['currency']);
+        }
+        else
+        {
+            $formatter->setPattern($pattern);
+            $output = $formatter->format($num);
+        }
 
         // This might lead a trailing period if $precision == 0
         $output = trim($output, '. ');

tests/system/Helpers/NumberHelperTest.php

@@ -81,4 +81,14 @@ public function test_quadrillions()
     {
         $this->assertEquals('123.5 quadrillion', number_to_amount('123,456,700,000,000,000', 1, 'en_US'));
     }
+
+    /**
+     * @group single
+     */
+    public function test_currency_current_locale()
+    {
+        $this->assertEquals('$1,234.56', number_to_currency(1234.56, 'USD', 'en_US'));
+        $this->assertEquals('£1,234.56', number_to_currency(1234.56, 'GBP', 'en_GB'));
+    }
+
 }