Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / b7263d152a3c29751e39fd74972707f62f51ca72 / . / user_guide / helpers / string_helper.html
blob: 314124037a2fa7381d34eedcf8254db2a7168959 [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>String 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>
Derek Jonesb8c038a2011-08-20 08:57:14 -0500[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.3</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;
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
Derek Jones37f4b9c2011-07-01 17:56:50 -0500[diff] [blame]73<p>Generates a random string based on the type and length you specify. Useful for creating passwords or generating random hashes.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]74
Derek Jones37f4b9c2011-07-01 17:56:50 -0500[diff] [blame]75<p>The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]76
Derek Allard472dd212010-01-23 20:03:27 +0000[diff] [blame]77 alpha, alunum, numeric, nozero, unique, md5, encrypt and sha1
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]78<ul>
Derek Allard472dd212010-01-23 20:03:27 +0000[diff] [blame]79 <li><strong>alpha</strong>:&nbsp; A string with lower and uppercase letters only.</li>
80 <li><strong>alnum</strong>:&nbsp; Alpha-numeric string with lower and uppercase characters.</li>
81 <li><strong>numeric</strong>:&nbsp; Numeric string.</li>
82 <li><strong>nozero</strong>:&nbsp; Numeric string with no zeros.</li>
83 <li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type.
84 Returns a fixed length 32 character string.</li>
85 <li><strong>sha1</strong>:&nbsp; An encrypted random number based on <kbd>do_hash()</kbd> from the <a href="security_helper.html">security helper</a>.</li>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]86</ul>
87
88<p>Usage example:</p>
89
90<code>echo random_string('alnum', 16);</code>
91
92
Phil Sturgeondbac73b2011-08-14 12:23:55 -0600[diff] [blame]93<h2>increment_string()</h2>
94
95<p>Increments a string by appending a number to it or increasing the number. Useful for creating "copies" or a file or duplicating database content which has unique titles or slugs.</p>
96
97<p>Usage example:</p>
98
99<code>echo increment_string('file', '_'); // "file_1"<br/>
100echo increment_string('file', '-', 2); // "file-2"<br/>
101echo increment_string('file-4'); // "file-5"<br/></code>
102
103
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]104<h2>alternator()</h2>
105
Derek Jones37f4b9c2011-07-01 17:56:50 -0500[diff] [blame]106<p>Allows two or more items to be alternated between, when cycling through a loop. Example:</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]107
108<code>for ($i = 0; $i < 10; $i++)<br />
109{<br />
110&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('string one', 'string two');<br />
111}<br />
112</code>
113
114<p>You can add as many parameters as you want, and with each iteration of your loop the next item will be returned.</p>
115
116<code>for ($i = 0; $i < 10; $i++)<br />
117{<br />
118&nbsp;&nbsp;&nbsp;&nbsp;echo alternator('one', 'two', 'three', 'four', 'five');<br />
119}<br />
120</code>
121
122<p><strong>Note:</strong> To use multiple separate calls to this function simply call the function with no arguments to re-initialize.</p>
123
124
125
126<h2>repeater()</h2>
127<p>Generates repeating copies of the data you submit. Example:</p>
128<code>$string = "\n";<br />
129echo repeater($string, 30);</code>
130
131<p>The above would generate 30 newlines.</p>
132<h2>reduce_double_slashes()</h2>
133<p>Converts double slashes in a string to a single slash, except those found in http://. Example: </p>
134<code>$string = &quot;http://example.com//index.php&quot;;<br />
135echo reduce_double_slashes($string); // results in &quot;http://example.com/index.php&quot;</code>
136<h2>trim_slashes()</h2>
137<p>Removes any leading/trailing slashes from a string. Example:<br />
138 <br />
139 <code>$string = &quot;/this/that/theother/&quot;;<br />
140echo trim_slashes($string); // results in this/that/theother</code></p>
141
142
143<h2>reduce_multiples()</h2>
144<p>Reduces multiple instances of a particular character occuring directly after each other. Example:</p>
145<code>
146$string="Fred, Bill,, Joe, Jimmy";<br />
147$string=reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
148</code>
149<p>The function accepts the following parameters:
150<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>
151
152The first parameter contains the string in which you want to reduce the multiplies. The second parameter contains the character you want to have reduced.
153The 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:
154
155<code>
156$string=",Fred, Bill,, Joe, Jimmy,";<br />
157$string=reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
158</code>
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]159</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]160
161<h2>quotes_to_entities()</h2>
162<p>Converts single and double quotes in a string to the corresponding HTML entities. Example:</p>
163<code>$string="Joe's \"dinner\"";<br />
164$string=quotes_to_entities($string); //results in "Joe&amp;#39;s &amp;quot;dinner&amp;quot;"
165</code>
166
167<h2>strip_quotes()</h2>
168<p>Removes single and double quotes from a string. Example:</p>
169<code>$string="Joe's \"dinner\"";<br />
170$string=strip_quotes($string); //results in "Joes dinner"
171</code>
172
173</div>
174<!-- END CONTENT -->
175
176
177<div id="footer">
178<p>
179Previous Topic:&nbsp;&nbsp;<a href="smiley_helper.html">Smiley Helper</a>
180&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
181<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
182<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
183Next Topic:&nbsp;&nbsp;<a href="text_helper.html">Text Helper</a>
184</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]185<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]186</div>
187
188</body>
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]189</html>