diff options
author | dchill42 <dchill42@gmail.com> | 2012-07-23 16:53:47 +0200 |
---|---|---|
committer | dchill42 <dchill42@gmail.com> | 2012-07-23 16:53:47 +0200 |
commit | c5079de78e5141330c07e990811ef15e998e95aa (patch) | |
tree | 0f39d8c4fc7614246fc185810bfeaa7fad88a33a /user_guide_src/source/helpers/number_helper.rst | |
parent | 00fcb545109d4e61bc14e403ec828749c34a54b3 (diff) | |
parent | ede49ba66b127535f3430e20aac72ceed2c4611a (diff) |
Merge branch develop of github.com:/EllisLab/CodeIgniter into session
Diffstat (limited to 'user_guide_src/source/helpers/number_helper.rst')
-rw-r--r-- | user_guide_src/source/helpers/number_helper.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst new file mode 100644 index 000000000..af6cdad57 --- /dev/null +++ b/user_guide_src/source/helpers/number_helper.rst @@ -0,0 +1,45 @@ +############# +Number Helper +############# + +The Number Helper file contains functions that help you work with +numeric data. + +.. contents:: Page Contents + +Loading this Helper +=================== + +This helper is loaded using the following code + +:: + + $this->load->helper('number'); + +The following functions are available: + +byte_format() +============= + +Formats a 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 + +An optional second parameter allows you to set the precision of the +result. + +:: + + 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 |