summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2013-07-20 01:47:54 +0200
committerDerek Jones <derek.jones@ellislab.com>2013-07-20 01:47:54 +0200
commitc8b742c22a54639cc30428a50dbafeee3d809329 (patch)
tree9a70c1f6e4cea7f94963e3d9d06cf1d223a93952
parent6851be175d1e7ab804a47d41d78807bef9805866 (diff)
Update Number helper docs
-rw-r--r--user_guide_src/source/helpers/number_helper.rst42
1 files changed, 24 insertions, 18 deletions
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 4e12f9a27..5a3d72b00 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -5,7 +5,12 @@ Number Helper
The Number Helper file contains functions that help you work with
numeric data.
-.. contents:: Page Contents
+.. contents::
+ :local:
+
+.. raw:: html
+
+ <div class="custom-index container"></div>
Loading this Helper
===================
@@ -14,32 +19,33 @@ This helper is loaded using the following code::
$this->load->helper('number');
+Available Functions
+===================
+
The following functions are available:
-byte_format()
-=============
-.. function:: byte_format($num, $precision = 1)
+.. function:: byte_format($num[, $precision = 1])
:param mixed $num: Number of bytes
:param int $precision: Floating point precision
:returns: string
-Formats numbers as bytes, based on size, and adds the appropriate
-suffix. Examples::
+ Formats numbers as bytes, based on size, and adds the appropriate
+ suffix. Examples::
- echo byte_format(456); // Returns 456 Bytes
- echo byte_format(4567); // Returns 4.5 KB
- echo byte_format(45678); // Returns 44.6 KB
- echo byte_format(456789); // Returns 447.8 KB
- echo byte_format(3456789); // Returns 3.3 MB
- echo byte_format(12345678912345); // Returns 1.8 GB
- echo byte_format(123456789123456789); // Returns 11,228.3 TB
+ echo byte_format(456); // Returns 456 Bytes
+ echo byte_format(4567); // Returns 4.5 KB
+ echo byte_format(45678); // Returns 44.6 KB
+ echo byte_format(456789); // Returns 447.8 KB
+ echo byte_format(3456789); // Returns 3.3 MB
+ echo byte_format(12345678912345); // Returns 1.8 GB
+ echo byte_format(123456789123456789); // Returns 11,228.3 TB
-An optional second parameter allows you to set the precision of the
-result::
+ An optional second parameter allows you to set the precision of the
+ result::
- echo byte_format(45678, 2); // Returns 44.61 KB
+ echo byte_format(45678, 2); // Returns 44.61 KB
-.. note:: The text generated by this function is found in the following
- language file: `language/<your_lang>/number_lang.php` \ No newline at end of file
+ .. note:: The text generated by this function is found in the following
+ language file: `language/<your_lang>/number_lang.php` \ No newline at end of file