blob: 2a906ba1b75783877c85a308f0e854cce0eaccf9 [file] [log] [blame]
Andrey Andreeva381d172012-01-06 19:19:37 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreeva381d172012-01-06 19:19:37 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreeva381d172012-01-06 19:19:37 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * 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
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @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
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * CodeIgniter Number Helpers
30 *
31 * @package CodeIgniter
32 * @subpackage Helpers
33 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/helpers/number_helper.html
36 */
37
38// ------------------------------------------------------------------------
39
Derek Allard2067d1a2008-11-13 22:59:24 +000040if ( ! function_exists('byte_format'))
41{
Timothy Warrenb75faa12012-04-27 12:03:32 -040042 /**
43 * Formats a numbers as bytes, based on size, and adds the appropriate suffix
44 *
45 * @param mixed // will be cast as int
46 * @param int
47 * @return string
48 */
Derek Allardfcbb0262010-01-17 16:13:15 +000049 function byte_format($num, $precision = 1)
Derek Allard2067d1a2008-11-13 22:59:24 +000050 {
51 $CI =& get_instance();
52 $CI->lang->load('number');
Barry Mienydd671972010-10-04 16:33:58 +020053
54 if ($num >= 1000000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000055 {
Derek Allardfcbb0262010-01-17 16:13:15 +000056 $num = round($num / 1099511627776, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000057 $unit = $CI->lang->line('terabyte_abbr');
58 }
Barry Mienydd671972010-10-04 16:33:58 +020059 elseif ($num >= 1000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000060 {
Derek Allardfcbb0262010-01-17 16:13:15 +000061 $num = round($num / 1073741824, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000062 $unit = $CI->lang->line('gigabyte_abbr');
63 }
Barry Mienydd671972010-10-04 16:33:58 +020064 elseif ($num >= 1000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000065 {
Derek Allardfcbb0262010-01-17 16:13:15 +000066 $num = round($num / 1048576, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000067 $unit = $CI->lang->line('megabyte_abbr');
68 }
Barry Mienydd671972010-10-04 16:33:58 +020069 elseif ($num >= 1000)
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
Derek Allardfcbb0262010-01-17 16:13:15 +000071 $num = round($num / 1024, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000072 $unit = $CI->lang->line('kilobyte_abbr');
73 }
74 else
75 {
76 $unit = $CI->lang->line('bytes');
77 return number_format($num).' '.$unit;
78 }
79
Derek Allardfcbb0262010-01-17 16:13:15 +000080 return number_format($num, $precision).' '.$unit;
Barry Mienydd671972010-10-04 16:33:58 +020081 }
Derek Allard2067d1a2008-11-13 22:59:24 +000082}
83
84/* End of file number_helper.php */
Andrey Andreev627e1722012-03-26 20:53:47 +030085/* Location: ./system/helpers/number_helper.php */