Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / eea2bdaaffcbee1a9efb56e60ae5712e30873f87 / . / user_guide / helpers / text_helper.html
blob: 260fad4a47ef4599bc928469c6523cb7d8617bcf [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 Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]5<title>CodeIgniter User Guide</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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
admine334c472006-10-21 19:44:22 +0000[diff] [blame]15 myHeight = new fx.Height('nav', {duration: 400});
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]25<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]36<td><h1>CodeIgniter User Guide Version 1.5.3</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]48<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Text Helper
51</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]52<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]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>Text Helper</h1>
65
66<p>The Text Helper file contains functions that assist in working with text.</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('text');</code>
73
74<p>The following functions are available:</p>
75
76
77<h2>word_limiter()</h2>
78
79<p>Truncates a string to the number of <strong>words</strong> specified. Example:</p>
80
81<code>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]82$string = "Here is a nice text string consisting of eleven words.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]83<br />
84$string = word_limiter($string, 4);<br /><br />
85
86// Returns: Here is a nice&#8230;
87</code>
88
89<p>The third parameter is an optional suffix added to the string. By default it add an ellipsis.</p>
90
91
92<h2>character_limiter()</h2>
93
94<p>Truncates a string to the number of <strong>characters</strong> specified. It maintains the integrity
95of words so the character count may be slightly more or less then what you specify. Example:</p>
96
97<code>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]98$string = "Here is a nice text string consisting of eleven words.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]99<br />
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]100$string = character_limiter($string, 20);<br /><br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]101
102// Returns: Here is a nice text string&#8230;
103</code>
104
105<p>The third parameter is an optional suffix added to the string. By default it add an ellipsis.</p>
106
107
108
109<h2>ascii_to_entities()</h2>
110
111<p>Converts ASCII values to character entities, including high ASCII and MS Word characters that can cause problems when used in a web page,
112so that they can be shown consistently regardless of browser settings or stored reliably in a database.
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]113There is some dependence on your server's supported character sets, so it may not be 100% reliable in all cases, but for the most
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]114part it should correctly identify characters outside the normal range (like accented characters). Example:</p>
115
116<code>$string = ascii_to_entities($string);</code>
117
118
119<h2>entities_to_ascii()</h2>
120
121<p>This function does the opposite of the previous one; it turns character entities back into ASCII.</p>
122
123
124<h2>word_censor()</h2>
125
126<p>Enables you to censor words within a text string. The first parameter will contain the original string. The
127second will contain an array of words which you disallow. The third (optional) parameter can contain a replacement value
128for the words. If not specified they are replaced with pound signs: ####. Example:</p>
129
130<code>
131$disallowed = array('darn', 'shucks', 'golly', 'phooey');<br />
132<br />
133$string = word_censor($string, $disallowed, 'Beep!');</code>
134
135
136<h2>highlight_code()</h2>
137
138<p>Colorizes a string of code (PHP, HTML, etc.). Example:</p>
139
140<code>$string = highlight_code($string);</code>
141
142<p>The function uses PHP's highlight_string() function, so the colors used are the ones specified in your php.ini file.</p>
143
144
145<h2>highlight_phrase()</h2>
146
147<p>Will highlight a phrase within a text string. The first parameter will contain the original string, the second will
148contain the phrase you wish to highlight. The third and fourth parameters will contain the opening/closing HTML tags
149you would like the phrase wrapped in. Example:</p>
150
151<code>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]152$string = "Here is a nice text string about nothing in particular.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]153<br />
154$string = highlight_phrase($string, "nice text", '&lt;span style="color:#990000">', '&lt;/span>');
155</code>
156
157<p>The above text returns:</p>
158
159<p>Here is a <span style="color:#990000">nice text</span> string about nothing in particular.</p>
160
161
162
163<h2>word_wrap()</h2>
164
165<p>Wraps text at the specified <strong>character</strong> count while maintaining complete words. Example:</p>
166
167<code>$string = "Here is a simple string of text that will help us demonstrate this function.";<br />
168<br />
169echo word_wrap($string, 25);<br />
170<br />
171// Would produce:<br />
172<br />
173Here is a simple string<br />
174of text that will help<br />
175us demonstrate this<br />
176function</code>
177
178
179
180
181</div>
182<!-- END CONTENT -->
183
184
185<div id="footer">
186<p>
187Previous Topic:&nbsp;&nbsp;<a href="string_helper.html">String Helper</a>
188&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
189<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
190<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
191Next Topic:&nbsp;&nbsp;<a href="typography_helper.html">Typography Helper</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]192</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]193<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]194</div>
195
196</body>
197</html>