blob: 71cdabb60ded82fde49b685c517bd63de8676e77 [file] [log] [blame]
Derek Jones37f4b9c2011-07-01 17:56:50 -05001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
8 *
9 * Licensed under the Open Software License version 3.0
10 *
11 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
21 * @copyright Copyright (c) 2008 - 2011, EllisLab, Inc. (http://ellislab.com/)
22 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
28// ------------------------------------------------------------------------
29
30/**
31 * CodeIgniter Number Helpers
32 *
33 * @package CodeIgniter
34 * @subpackage Helpers
35 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050036 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000037 * @link http://codeigniter.com/user_guide/helpers/number_helper.html
38 */
39
40// ------------------------------------------------------------------------
41
42/**
43 * Formats a numbers as bytes, based on size, and adds the appropriate suffix
44 *
45 * @access public
46 * @param mixed // will be cast as int
47 * @return string
48 */
49if ( ! function_exists('byte_format'))
50{
Derek Allardfcbb0262010-01-17 16:13:15 +000051 function byte_format($num, $precision = 1)
Derek Allard2067d1a2008-11-13 22:59:24 +000052 {
53 $CI =& get_instance();
54 $CI->lang->load('number');
Barry Mienydd671972010-10-04 16:33:58 +020055
56 if ($num >= 1000000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000057 {
Derek Allardfcbb0262010-01-17 16:13:15 +000058 $num = round($num / 1099511627776, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000059 $unit = $CI->lang->line('terabyte_abbr');
60 }
Barry Mienydd671972010-10-04 16:33:58 +020061 elseif ($num >= 1000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000062 {
Derek Allardfcbb0262010-01-17 16:13:15 +000063 $num = round($num / 1073741824, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000064 $unit = $CI->lang->line('gigabyte_abbr');
65 }
Barry Mienydd671972010-10-04 16:33:58 +020066 elseif ($num >= 1000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000067 {
Derek Allardfcbb0262010-01-17 16:13:15 +000068 $num = round($num / 1048576, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000069 $unit = $CI->lang->line('megabyte_abbr');
70 }
Barry Mienydd671972010-10-04 16:33:58 +020071 elseif ($num >= 1000)
Derek Allard2067d1a2008-11-13 22:59:24 +000072 {
Derek Allardfcbb0262010-01-17 16:13:15 +000073 $num = round($num / 1024, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000074 $unit = $CI->lang->line('kilobyte_abbr');
75 }
76 else
77 {
78 $unit = $CI->lang->line('bytes');
79 return number_format($num).' '.$unit;
80 }
81
Derek Allardfcbb0262010-01-17 16:13:15 +000082 return number_format($num, $precision).' '.$unit;
Barry Mienydd671972010-10-04 16:33:58 +020083 }
Derek Allard2067d1a2008-11-13 22:59:24 +000084}
85
Derek Allardfcbb0262010-01-17 16:13:15 +000086
Derek Allard2067d1a2008-11-13 22:59:24 +000087/* End of file number_helper.php */
Derek Jonesa935c3f2008-06-19 17:42:55 +000088/* Location: ./system/helpers/number_helper.php */