Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 48d6d5856ea95dd363f2a420f08200f488fb5151 / . / user_guide / helpers / text_helper.html
blob: f71d878405f8079106993c2b2efb83c1c443adc2 [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>Text 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>
Pascal Kriete1f622292011-04-07 12:06:51 -0400[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.2</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;
45Text 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>Text Helper</h1>
60
61<p>The Text Helper file contains functions that assist in working with text.</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('text');</code>
68
69<p>The following functions are available:</p>
70
71
72<h2>word_limiter()</h2>
73
74<p>Truncates a string to the number of <strong>words</strong> specified. Example:</p>
75
76<code>
77$string = "Here is a nice text string consisting of eleven words.";<br />
78<br />
79$string = word_limiter($string, 4);<br /><br />
80
81// Returns: Here is a nice&#8230;
82</code>
83
84<p>The third parameter is an optional suffix added to the string. By default it adds an ellipsis.</p>
85
86
87<h2>character_limiter()</h2>
88
89<p>Truncates a string to the number of <strong>characters</strong> specified. It maintains the integrity
90of words so the character count may be slightly more or less then what you specify. Example:</p>
91
92<code>
93$string = "Here is a nice text string consisting of eleven words.";<br />
94<br />
95$string = character_limiter($string, 20);<br /><br />
96
97// Returns: Here is a nice text string&#8230;
98</code>
99
100<p>The third parameter is an optional suffix added to the string, if undeclared this helper uses an ellipsis.</p>
101
102
103
104<h2>ascii_to_entities()</h2>
105
106<p>Converts ASCII values to character entities, including high ASCII and MS Word characters that can cause problems when used in a web page,
107so that they can be shown consistently regardless of browser settings or stored reliably in a database.
108There is some dependence on your server's supported character sets, so it may not be 100% reliable in all cases, but for the most
109part it should correctly identify characters outside the normal range (like accented characters). Example:</p>
110
111<code>$string = ascii_to_entities($string);</code>
112
113
114<h2>entities_to_ascii()</h2>
115
116<p>This function does the opposite of the previous one; it turns character entities back into ASCII.</p>
117
Derek Jones1a195922010-03-10 14:22:59 -0600[diff] [blame]118<h2>convert_accented_characters()</h2>
119
120<p>Transliterates high ASCII characters to low ASCII equivalents, useful when non-English characters need to be used where only standard ASCII characters are safely used, for instance, in URLs.</p>
121
122<code>$string = convert_accented_characters($string);</code>
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]123
Derek Jonesf0b39942010-03-25 10:08:20 -0500[diff] [blame]124<p>This function uses a companion config file <dfn>application/config/foreign_chars.php</dfn> to define the to and from array for transliteration.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]125
126<h2>word_censor()</h2>
127
128<p>Enables you to censor words within a text string. The first parameter will contain the original string. The
129second will contain an array of words which you disallow. The third (optional) parameter can contain a replacement value
130for the words. If not specified they are replaced with pound signs: ####. Example:</p>
131
132<code>
133$disallowed = array('darn', 'shucks', 'golly', 'phooey');<br />
134<br />
135$string = word_censor($string, $disallowed, 'Beep!');</code>
136
137
138<h2>highlight_code()</h2>
139
140<p>Colorizes a string of code (PHP, HTML, etc.). Example:</p>
141
142<code>$string = highlight_code($string);</code>
143
144<p>The function uses PHP's highlight_string() function, so the colors used are the ones specified in your php.ini file.</p>
145
146
147<h2>highlight_phrase()</h2>
148
149<p>Will highlight a phrase within a text string. The first parameter will contain the original string, the second will
150contain the phrase you wish to highlight. The third and fourth parameters will contain the opening/closing HTML tags
151you would like the phrase wrapped in. Example:</p>
152
153<code>
154$string = "Here is a nice text string about nothing in particular.";<br />
155<br />
156$string = highlight_phrase($string, "nice text", '&lt;span style="color:#990000">', '&lt;/span>');
157</code>
158
159<p>The above text returns:</p>
160
161<p>Here is a <span style="color:#990000">nice text</span> string about nothing in particular.</p>
162
163
164
165<h2>word_wrap()</h2>
166
167<p>Wraps text at the specified <strong>character</strong> count while maintaining complete words. Example:</p>
168
169<code>$string = "Here is a simple string of text that will help us demonstrate this function.";<br />
170<br />
171echo word_wrap($string, 25);<br />
172<br />
173// Would produce:<br />
174<br />
175Here is a simple string<br />
176of text that will help<br />
177us demonstrate this<br />
178function</code>
179
Greg Akercbe32472010-08-05 14:09:20 -0500[diff] [blame]180<h2>ellipsize()</h2>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]181
Greg Akercbe32472010-08-05 14:09:20 -0500[diff] [blame]182<p>This function will strip tags from a string, split it at a defined maximum length, and insert an ellipsis.</p>
183<p>The first parameter is the string to ellipsize, the second is the number of characters in the final string. The third parameter is where in the string the ellipsis should appear from 0 - 1, left to right. For example. a value of 1 will place the ellipsis at the right of the string, .5 in the middle, and 0 at the left.</p>
184<p>An optional forth parameter is the kind of ellipsis. By default, <samp>&amp;hellip;</samp> will be inserted.</p>
185
186<code>$str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';<br />
187<br />
188echo ellipsize($str, 32, .5);</code>
189
190Produces:
191
192<code>this_string_is_e&hellip;ak_my_design.jpg</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]193
194
195</div>
196<!-- END CONTENT -->
197
198
199<div id="footer">
200<p>
201Previous Topic:&nbsp;&nbsp;<a href="string_helper.html">String Helper</a>
202&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
203<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
204<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
205Next Topic:&nbsp;&nbsp;<a href="typography_helper.html">Typography Helper</a>
206</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]207<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]208</div>
209
210</body>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]211</html>