Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 9c63d0bb34be4007178d5a7e46348d5e23fee3ff / . / user_guide / helpers / number_helper.html
blob: c48987e6c113c00874d9caf1707eb8667fdcc3c9 [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Number Helper : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Phil Sturgeon9c63d0b2011-10-27 01:55:44 +0100[diff] [blame^]31<td><h1>CodeIgniter User Guide Version 2.1.0</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Number Helper
46</td>
47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Number Helper</h1>
60
61<p>The Number Helper file contains functions that help you work with numeric data.</p>
62
63
64<h2>Loading this Helper</h2>
65
66<p>This helper is loaded using the following code:</p>
67<code>$this->load->helper('number');</code>
68
69<p>The following functions are available:</p>
70
71
72<h2>byte_format()</h2>
73
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]74<p>Formats a numbers as bytes, based on size, and adds the appropriate suffix. Examples:</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]75
76<code>
77echo byte_format(456); // Returns 456 Bytes<br />
78echo byte_format(4567); // Returns 4.5 KB<br />
Derek Allardfcbb0262010-01-17 16:13:15 +0000[diff] [blame]79echo byte_format(45678); // Returns 44.6 KB<br />
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]80echo byte_format(456789); // Returns 447.8 KB<br />
81echo byte_format(3456789); // Returns 3.3 MB<br />
82echo byte_format(12345678912345); // Returns 1.8 GB<br />
83echo byte_format(123456789123456789); // Returns 11,228.3 TB
84</code>
85
Derek Allardfcbb0262010-01-17 16:13:15 +0000[diff] [blame]86<p>An optional second parameter allows you to set the precision of the result.</p>
87
88<code>
89echo byte_format(45678, 2); // Returns 44.61 KB
90</code>
91
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]92<p class="important">
93<strong>Note:</strong>
94The text generated by this function is found in the following language file: language/<your_lang>/number_lang.php
95</p>
96
97</div>
98<!-- END CONTENT -->
99
100
101<div id="footer">
102<p>
103Previous Topic:&nbsp;&nbsp;<a href="inflector_helper.html">Inflector Helper</a>
104&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
105<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
106<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
107Next Topic:&nbsp;&nbsp;<a href="path_helper.html">Path Helper</a>
108</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]109<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]110</div>
111
112</body>
Derek Allard33f6c682008-06-19 18:08:04 +0000[diff] [blame]113</html>