blob: 15a53ff725ff3417b27ba1d0dfc0d7199cb6657f [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreeva381d172012-01-06 19:19:37 +02008 *
Instructor, BCIT0e59db62019-01-01 08:34:36 -08009 * Copyright (c) 2014 - 2019, British Columbia Institute of Technology
Andrey Andreeva381d172012-01-06 19:19:37 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Instructor, BCIT0e59db62019-01-01 08:34:36 -080032 * @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
33 * @license https://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
41 * CodeIgniter Number Helpers
42 *
43 * @package CodeIgniter
44 * @subpackage Helpers
45 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Andrey Andreevbd202c92016-01-11 12:50:18 +020047 * @link https://codeigniter.com/user_guide/helpers/number_helper.html
Derek Allard2067d1a2008-11-13 22:59:24 +000048 */
49
50// ------------------------------------------------------------------------
51
Derek Allard2067d1a2008-11-13 22:59:24 +000052if ( ! function_exists('byte_format'))
53{
Timothy Warrenb75faa12012-04-27 12:03:32 -040054 /**
55 * Formats a numbers as bytes, based on size, and adds the appropriate suffix
56 *
Timothy Warrenf0eb2f12012-05-17 08:32:11 -040057 * @param mixed will be cast as int
Timothy Warrenb75faa12012-04-27 12:03:32 -040058 * @param int
59 * @return string
60 */
Derek Allardfcbb0262010-01-17 16:13:15 +000061 function byte_format($num, $precision = 1)
Derek Allard2067d1a2008-11-13 22:59:24 +000062 {
63 $CI =& get_instance();
64 $CI->lang->load('number');
Barry Mienydd671972010-10-04 16:33:58 +020065
66 if ($num >= 1000000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000067 {
Derek Allardfcbb0262010-01-17 16:13:15 +000068 $num = round($num / 1099511627776, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000069 $unit = $CI->lang->line('terabyte_abbr');
70 }
Barry Mienydd671972010-10-04 16:33:58 +020071 elseif ($num >= 1000000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000072 {
Derek Allardfcbb0262010-01-17 16:13:15 +000073 $num = round($num / 1073741824, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000074 $unit = $CI->lang->line('gigabyte_abbr');
75 }
Barry Mienydd671972010-10-04 16:33:58 +020076 elseif ($num >= 1000000)
Derek Allard2067d1a2008-11-13 22:59:24 +000077 {
Derek Allardfcbb0262010-01-17 16:13:15 +000078 $num = round($num / 1048576, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000079 $unit = $CI->lang->line('megabyte_abbr');
80 }
Barry Mienydd671972010-10-04 16:33:58 +020081 elseif ($num >= 1000)
Derek Allard2067d1a2008-11-13 22:59:24 +000082 {
Derek Allardfcbb0262010-01-17 16:13:15 +000083 $num = round($num / 1024, $precision);
Derek Allard2067d1a2008-11-13 22:59:24 +000084 $unit = $CI->lang->line('kilobyte_abbr');
85 }
86 else
87 {
88 $unit = $CI->lang->line('bytes');
89 return number_format($num).' '.$unit;
90 }
91
Derek Allardfcbb0262010-01-17 16:13:15 +000092 return number_format($num, $precision).' '.$unit;
Barry Mienydd671972010-10-04 16:33:58 +020093 }
Derek Allard2067d1a2008-11-13 22:59:24 +000094}