Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 41a1685573aa0ede15a9bf7b373c36a0406fb19d / . / user_guide / helpers / string_helper.html
blob: 176573cf98d9013a116a9568dc40db735429b0fb [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +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>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
10<script type="text/javascript" src="../scripts/nav.js"></script>
11<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
12<script type="text/javascript" src="../scripts/moo.fx.js"></script>
13<script type="text/javascript">
14window.onload = function() {
15 myHeight = new fx.Height('nav', {duration: 400});
16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
admin41a16852006-09-26 18:17:19 +0000[diff] [blame^]36<td><h1>Code Igniter User Guide Version 1.5.0</h1></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50String Helper
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63
64<h1>String Helper</h1>
65
66<p>The String Helper file contains functions that assist in working with strings.</p>
67
68
69<h2>Loading this Helper</h2>
70
71<p>This helper is loaded using the following code:</p>
72<code>$this->load->helper('string');</code>
73
74<p>The following functions are available:</p>
75
76<h2>random_string()</h2>
77
78<p>Generates a random string based on the type and length you specify. Useful for creating passwords or generating random hashes.</p>
79
80<p>The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:</p>
81
82
83<ul>
84<li><strong>alnum</strong>:&nbsp; Alpha-numeric string with lower and uppercase characters.</li>
85<li><strong>numeric</strong>:&nbsp; Numeric string.</li>
86<li><strong>nozero</strong>:&nbsp; Numeric string with no zeros.</li>
87<li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniquid(). Note: The length parameter is not available for this type.
88Returns a fixed length 33 character string.</li>
89</ul>
90
91<p>Usage example:</p>
92
93<code>echo random_string('alnum', 16);</code>
94
95
96<h2>alternator()</h2>
97
98<p>Allows two or more items to be alternated between, when cycling through a loop. Example:
99
100<code>for ($i = 0; $i < 10; $i++)<br />
101{<br />
102&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('string one', 'string two');<br />
103}<br />
104</code>
105
106<p>You can add as many parameters as you want, and with each each iteration of your loop the next item will be returned.</p>
107
108<code>for ($i = 0; $i < 10; $i++)<br />
109{<br />
110&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('one', 'two', 'three', 'four', 'five');<br />
111}<br />
112</code>
113
114<p><strong>Note:</strong> To use multiple separate calls to this function simply call the function with no arguments to re-initialize.</p>
115
116
117
118<h2>repeater()</h2>
119<p>Generates repeating copies of the data you submit. Example:</p>
120<code>$string = "\n";<br />
121echo repeater($string, 30);</code>
122
123<p>The above would generate 30 newlines.</p>
124
125
126
127
128</div>
129<!-- END CONTENT -->
130
131
132<div id="footer">
133<p>
134Previous Topic:&nbsp;&nbsp;<a href="security_helper.html">Security Helper</a>
135&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
136<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
137<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
138Next Topic:&nbsp;&nbsp;<a href="text_helper.html">Text Helper</a>
139<p>
140<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
141</div>
142
143</body>
144</html>