Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 1ea127ae8a8026af7679526af06ff297d5104104 / . / user_guide / helpers / string_helper.html
blob: 489c6b3fbd74452b96be6d1fec98933516fc92af [file] [log] [blame]
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]3<head>
4
5<title>CodeIgniter User Guide : String Helper</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="../nav/nav.js"></script>
11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
12<script type="text/javascript" src="../nav/moo.fx.js"></script>
13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
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' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]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.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 Allard197d10b2008-02-12 04:20:38 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.1</h1></td>
Derek Allard39b622d2008-01-16 21:10:09 +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">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45String 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>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>
82<li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type.
Derek Allardaf6a8be2008-01-21 15:24:06 +0000[diff] [blame]83Returns a fixed length 32 character string.</li>
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]84</ul>
85
86<p>Usage example:</p>
87
88<code>echo random_string('alnum', 16);</code>
89
90
91<h2>alternator()</h2>
92
93<p>Allows two or more items to be alternated between, when cycling through a loop. Example:</p>
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
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>
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>
119<h2>reduce_double_slashes()</h2>
120<p>Converts double slashes in a string to a single slash, except those found in http://. Example: </p>
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>
123<h2>trim_slashes()</h2>
124<p>Removes any leading/trailing slashes from a string. Example:<br />
125 <br />
126 <code>$string = &quot;/this/that/theother/&quot;;<br />
127echo trim_slashes($string); // results in this/that/theother</code></p>
128
129
130<h2>reduce_multiples()</h2>
131<p>Reduces multiple instances of a particular character occuring directly after each other. Example:</p>
132<code>
133$string="Fred, Bill,, Joe, Jimmy";<br />
134$string=reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
135</code>
136<p>The function accepts the following parameters:
137<code>reduce_multiples(string: text to search in, string: character to reduce, boolean: whether to remove the character from the front and end of the string)</code>
138
Derek Allard140786f2008-04-01 16:06:08 +0000[diff] [blame]139The first parameter contains the string in which you want to reduce the multiplies. The second parameter contains the character you want to have reduced.
140The third parameter is FALSE by default; if set to TRUE it will remove occurences of the character at the beginning and the end of the string. Example:
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]141
142<code>
143$string=",Fred, Bill,, Joe, Jimmy,";<br />
Derek Allard140786f2008-04-01 16:06:08 +0000[diff] [blame]144$string=reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]145</code>
146</p>
147
148<h2>quotes_to_entities()</h2>
149<p>Converts single and double quotes in a string to the corresponding HTML entities. Example:</p>
150<code>$string="Joe's \"dinner\"";<br />
151$string=quotes_to_entities($string); //results in "Joe&amp;#39;s &amp;quot;dinner&amp;quot;"
152</code>
153
154<h2>strip_quotes()</h2>
155<p>Removes single and double quotes from a string. Example:</p>
156<code>$string="Joe's \"dinner\"";<br />
157$string=strip_quotes($string); //results in "Joes dinner"
158</code>
159
160</div>
161<!-- END CONTENT -->
162
163
164<div id="footer">
165<p>
166Previous Topic:&nbsp;&nbsp;<a href="smiley_helper.html">Smiley Helper</a>
167&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
168<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
169<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
170Next Topic:&nbsp;&nbsp;<a href="text_helper.html">Text Helper</a>
171</p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]172<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]173</div>
174
175</body>
176</html>