Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 63c4591fb9db1c3711a93e985bc39f61d14476ff / . / user_guide / helpers / text_helper.html
blob: 77527d6670828f4200a9a7ae5be5537bef7e2cfa [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">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Text 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' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
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 Allard067f2cc2008-02-04 22:12:03 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.1</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 Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://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;
45Text 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>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>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]77$string = "Here is a nice text string consisting of eleven words.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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 add 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>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]93$string = "Here is a nice text string consisting of eleven words.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]94<br />
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]95$string = character_limiter($string, 20);<br /><br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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. By default it add 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.
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]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
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
118
119<h2>word_censor()</h2>
120
121<p>Enables you to censor words within a text string. The first parameter will contain the original string. The
122second will contain an array of words which you disallow. The third (optional) parameter can contain a replacement value
123for the words. If not specified they are replaced with pound signs: ####. Example:</p>
124
125<code>
126$disallowed = array('darn', 'shucks', 'golly', 'phooey');<br />
127<br />
128$string = word_censor($string, $disallowed, 'Beep!');</code>
129
130
131<h2>highlight_code()</h2>
132
133<p>Colorizes a string of code (PHP, HTML, etc.). Example:</p>
134
135<code>$string = highlight_code($string);</code>
136
137<p>The function uses PHP's highlight_string() function, so the colors used are the ones specified in your php.ini file.</p>
138
139
140<h2>highlight_phrase()</h2>
141
142<p>Will highlight a phrase within a text string. The first parameter will contain the original string, the second will
143contain the phrase you wish to highlight. The third and fourth parameters will contain the opening/closing HTML tags
144you would like the phrase wrapped in. Example:</p>
145
146<code>
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]147$string = "Here is a nice text string about nothing in particular.";<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]148<br />
149$string = highlight_phrase($string, "nice text", '&lt;span style="color:#990000">', '&lt;/span>');
150</code>
151
152<p>The above text returns:</p>
153
154<p>Here is a <span style="color:#990000">nice text</span> string about nothing in particular.</p>
155
156
157
158<h2>word_wrap()</h2>
159
160<p>Wraps text at the specified <strong>character</strong> count while maintaining complete words. Example:</p>
161
162<code>$string = "Here is a simple string of text that will help us demonstrate this function.";<br />
163<br />
164echo word_wrap($string, 25);<br />
165<br />
166// Would produce:<br />
167<br />
168Here is a simple string<br />
169of text that will help<br />
170us demonstrate this<br />
171function</code>
172
173
174
175
176</div>
177<!-- END CONTENT -->
178
179
180<div id="footer">
181<p>
182Previous Topic:&nbsp;&nbsp;<a href="string_helper.html">String Helper</a>
183&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
184<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
185<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
186Next Topic:&nbsp;&nbsp;<a href="typography_helper.html">Typography Helper</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]187</p>
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]188<p><a href="http://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]189</div>
190
191</body>
192</html>