Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 375d9bac3453e309900b475cb4a1efb836f97440 / . / user_guide / helpers / string_helper.html
blob: 37902177e56259e97a7a7af875729b8b88823932 [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
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : String Helper</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
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='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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.jpg" width="153" height="44" 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>
Derek Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45String Helper
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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>String Helper</h1>
60
61<p>The String Helper file contains functions that assist in working with strings.</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('string');</code>
68
69<p>The following functions are available:</p>
70
71<h2>random_string()</h2>
72
73<p>Generates a random string based on the type and length you specify. Useful for creating passwords or generating random hashes.</p>
74
75<p>The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:</p>
76
77
78<ul>
79<li><strong>alnum</strong>:&nbsp; Alpha-numeric string with lower and uppercase characters.</li>
80<li><strong>numeric</strong>:&nbsp; Numeric string.</li>
81<li><strong>nozero</strong>:&nbsp; Numeric string with no zeros.</li>
Derek Allard2bee4c02007-09-24 12:13:47 +0000[diff] [blame]82<li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]83Returns a fixed length 33 character string.</li>
84</ul>
85
86<p>Usage example:</p>
87
88<code>echo random_string('alnum', 16);</code>
89
90
91<h2>alternator()</h2>
92
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]93<p>Allows two or more items to be alternated between, when cycling through a loop. Example:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]94
95<code>for ($i = 0; $i < 10; $i++)<br />
96{<br />
97&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('string one', 'string two');<br />
98}<br />
99</code>
100
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]101<p>You can add as many parameters as you want, and with each iteration of your loop the next item will be returned.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]102
103<code>for ($i = 0; $i < 10; $i++)<br />
104{<br />
105&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('one', 'two', 'three', 'four', 'five');<br />
106}<br />
107</code>
108
109<p><strong>Note:</strong> To use multiple separate calls to this function simply call the function with no arguments to re-initialize.</p>
110
111
112
113<h2>repeater()</h2>
114<p>Generates repeating copies of the data you submit. Example:</p>
115<code>$string = "\n";<br />
116echo repeater($string, 30);</code>
117
118<p>The above would generate 30 newlines.</p>
Derek Allard08515302007-07-12 12:49:54 +0000[diff] [blame]119<h2>reduce_double_slashes()</h2>
Derek Jonesaa8dc3c2007-07-12 13:45:36 +0000[diff] [blame]120<p>Converts double slashes in a string to a single slash, except those found in http://. Example: </p>
Derek Allard8788d4b2007-08-08 17:04:40 +0000[diff] [blame]121<code>$string = &quot;http://www.example.com//index.php&quot;;<br />
122echo reduce_double_slashes($string); // results in &quot;http://www.example.com/index.php&quot;</code>
Derek Allard08515302007-07-12 12:49:54 +0000[diff] [blame]123<h2>trim_slashes()</h2>
Derek Jonesaa8dc3c2007-07-12 13:45:36 +0000[diff] [blame]124<p>Removes any leading/trailing slashes from a string. Example:<br />
Derek Allard08515302007-07-12 12:49:54 +0000[diff] [blame]125 <br />
126 <code>$string = &quot;/this/that/theother/&quot;;<br />
127echo trim_slashes($string); // results in this/that/theother</code></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]128</div>
129<!-- END CONTENT -->
130
131
132<div id="footer">
133<p>
admin05186612006-10-28 03:28:01 +0000[diff] [blame]134Previous Topic:&nbsp;&nbsp;<a href="smiley_helper.html">Smiley Helper</a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]139</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]140<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]141</div>
142
143</body>
144</html>