blob: 9dcd1fc78cc2a4ac803dc8214b14c65c38ec298d [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +00001<!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>Inflector 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 Jones8917af72010-03-05 12:41:45 -060031<td><h1>CodeIgniter User Guide Version 2.0.0</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +000032<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;
45Inflector 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>Inflector Helper</h1>
60
61<p>The Inflector Helper file contains functions that permits you to change words to plural, singular, camel case, etc.</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('inflector');</code>
68
69<p>The following functions are available:</p>
70
71
72<h2>singular()</h2>
73
74<p>Changes a plural word to singular. Example:</p>
75
76<code>
77$word = "dogs";<br />
78echo singular($word); // Returns "dog"
79</code>
80
81
82<h2>plural()</h2>
83
84<p>Changes a singular word to plural. Example:</p>
85
86<code>
87$word = "dog";<br />
88echo plural($word); // Returns "dogs"
89</code>
90
91
92<p>To force a word to end with &quot;es&quot; use a second &quot;true&quot; argument. </p>
93<code> $word = &quot;pass&quot;;<br />
94echo plural($word, TRUE); // Returns &quot;passes&quot; </code>
95
96<h2>camelize()</h2>
97<p>Changes a string of words separated by spaces or underscores to camel case. Example:</p>
98
99<code>
100$word = "my_dog_spot";<br />
101echo camelize($word); // Returns "myDogSpot"
102</code>
103
104
105<h2>underscore()</h2>
106
107<p>Takes multiple words separated by spaces and underscores them. Example:</p>
108
109<code>
110$word = "my dog spot";<br />
111echo underscore($word); // Returns "my_dog_spot"
112</code>
113
114
115<h2>humanize()</h2>
116
117<p>Takes multiple words separated by underscores and adds spaces between them. Each word is capitalized. Example:</p>
118
119<code>
120$word = "my_dog_spot";<br />
121echo humanize($word); // Returns "My Dog Spot"
122</code>
123
124
125
126
127
128
129
130
131
132
133
134
135</div>
136<!-- END CONTENT -->
137
138
139<div id="footer">
140<p>
141Previous Topic:&nbsp;&nbsp;<a href="html_helper.html"> HTML Helper</a>
142&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
143<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
144<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
145Next Topic:&nbsp;&nbsp;<a href="number_helper.html">Number Helper</a>
146</p>
Derek Jonesd6d70e32010-03-29 10:10:27 -0500147<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2010 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000148</div>
149
150</body>
admine21a7b22006-09-20 23:58:54 +0000151</html>