Number helper docs

Author: lonnieezell

system/Helpers/number_helper.php

@@ -107,7 +107,7 @@ function number_to_size($num, int $precision = 1, string $locale=null)
      *
      * @return bool|string
      */
-    function number_to_amount($num, int $precision, string $locale = null)
+    function number_to_amount($num, int $precision = 0, string $locale = null)
     {
         // Strip any formatting
         $num = 0 + str_replace(',','',$num);
@@ -154,7 +154,7 @@ 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)
+    function number_to_currency($num, string $currency, string $locale = null)
     {
         return format_number($num, 1, $locale, [
             'type' => NumberFormatter::CURRENCY,

user_guide_src/source/helpers/number_helper.rst

@@ -0,0 +1,103 @@
+#############
+Number Helper
+#############
+
+The Number Helper file contains functions that help you work with
+numeric data in a locale-aware manner.
+
+.. contents::
+:local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+Loading this Helper
+===================
+
+This helper is loaded using the following code::
+
+	helper('number');
+
+Available Functions
+===================
+
+The following functions are available:
+
+
+.. php:function:: number_to_size($num[, $precision = 1[, $locale = null])
+
+	:param	mixed	$num: Number of bytes
+    :param	int	$precision: Floating point precision
+    :returns:	Formatted data size string
+    :rtype:	string
+
+    Formats numbers as bytes, based on size, and adds the appropriate
+    suffix. Examples::
+
+		echo number_to_size(456); // Returns 456 Bytes
+		echo number_to_size(4567); // Returns 4.5 KB
+		echo number_to_size(45678); // Returns 44.6 KB
+		echo number_to_size(456789); // Returns 447.8 KB
+		echo number_to_size(3456789); // Returns 3.3 MB
+		echo number_to_size(12345678912345); // Returns 1.8 GB
+		echo number_to_size(123456789123456789); // Returns 11,228.3 TB
+
+	An optional second parameter allows you to set the precision of the
+	result::
+
+		 echo number_to_size(45678, 2); // Returns 44.61 KB
+
+    An optional third parameter allows you to specify the locale that should
+    be used when generating the number, and can affect the formatting. If no
+    locale is specified, the Request will be analyzed and an appropriate
+    locale taken from the headers, or the app-default::
+
+        // Generates 11.2 TB
+        echo number_to_size(12345678912345, 1, 'en_US');
+        // Generates 11,2 TB
+        echo number_to_size(12345678912345, 1, 'fr_FR');
+
+
+	.. note:: The text generated by this function is found in the following
+		language file: *language/<your_lang>/Number.php*
+
+.. php:function:: number_to_amount($num[, $precision = 1[, $locale = null])
+
+    :param	mixed	$num: Number to format
+    :param	int	$precision: Floating point precision
+    :param  string $locale: The locale to use for formatting
+    :returns:	A human-readable version of the string
+    :rtype:	string
+
+    Converts a number into a human-readable version, like **123.4 trillion**
+    for numbers up to the quadrillions. Examples::
+
+        echo number_to_amount(123456); // Returns 123 thousand
+        echo number_to_amount(123456789); // Returns 123 million
+        echo number_to_amount(1234567890123, 2); // Returns 1.23 trillion
+        echo number_to_amount('123,456,789,012', 2); // Returns 123.46 billion
+
+    An optional second parameter allows you to set the precision of the
+	result::
+
+		 echo number_to_amount(45678, 2); // Returns 45.68 thousand
+
+    An optional third parameter allows the locale to be specified::
+
+        echo number_to_amount('123,456,789,012', 2, 'de_DE'); // Returns 123,46 billion
+
+.. php:function:: number_to_currency($num, $currency[, $locale = null])
+
+    :param mixed $num: Number to format
+    :param string $currency: The currency type, i.e. USD, EUR, etc
+    :param string $locale: The locale to use for formatting
+    :returns: The number as the appropriate currency for the locale
+    :rtype: string
+
+    Converts a number in common currency formats, like USD, EUR, GBP, etc::
+
+        echo number_to_currency(1234.56, 'USD');  // Returns $1,234.56
+        echo number_to_currency(1234.56, 'EUR');  // Returns £1,234.56
+        echo number_to_currency(1234.56, 'GBP');  // Returns £1,234.56
+        echo number_to_currency(1234.56, 'YEN');  // Returns YEN1,234.56