52 lines
1.3 KiB
ReStructuredText
52 lines
1.3 KiB
ReStructuredText
#############
|
|
Number Helper
|
|
#############
|
|
|
|
The Number Helper file contains functions that help you work with
|
|
numeric data.
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
.. raw:: html
|
|
|
|
<div class="custom-index container"></div>
|
|
|
|
Loading this Helper
|
|
===================
|
|
|
|
This helper is loaded using the following code::
|
|
|
|
$this->load->helper('number');
|
|
|
|
Available Functions
|
|
===================
|
|
|
|
The following functions are available:
|
|
|
|
|
|
.. php:function:: byte_format($num[, $precision = 1])
|
|
|
|
: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 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* |