blob: 3d8d1808c3d6b740ed6103a35046242fe1c0947b [file] [log] [blame]
admine21a7b22006-09-20 23:58:54 +00001<!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
5<title>Code Igniter User Guide</title>
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 +000010<script type="text/javascript" src="../nav/nav.js"></script>
admine21a7b22006-09-20 23:58:54 +000011<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +000012<script type="text/javascript" src="../nav/moo.fx.js"></script>
admine21a7b22006-09-20 23:58:54 +000013<script type="text/javascript">
14window.onload = function() {
15 myHeight = new fx.Height('nav', {duration: 400});
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' />
25<meta name='description' content='Code Igniter User Guide' />
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>
admin41a16852006-09-26 18:17:19 +000036<td><h1>Code Igniter User Guide Version 1.5.0</h1></td>
admine21a7b22006-09-20 23:58:54 +000037<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
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">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Inflector Helper
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
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>Inflector Helper</h1>
65
66<p>The Inflector Helper file contains functions that permits you to change words to plural, singular, camel case, etc.</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('inflector');</code>
73
74<p>The following functions are available:</p>
75
76
77<h2>singular()</h2>
78
79<p>Changes a singular word to plural. Example:</p>
80
81<code>
82$word = "dogs";<br />
83echo singular($word); // Returns "dog"
84</code>
85
86
87<h2>plural()</h2>
88
89<p>Changes a plural word to singular. Example:</p>
90
91<code>
92$word = "dog";<br />
93echo plural($word); // Returns "dogs"
94</code>
95
96
97<h2>camelize()</h2>
98
99<p>Changes a string of words separated by spaces or underscores to camel case. Example:</p>
100
101<code>
102$word = "my_dog_spot";<br />
103echo camelize($word); // Returns "myDogSpot"
104</code>
105
106
107<h2>underscore()</h2>
108
109<p>Takes multiple words separated by spaces and underscores them. Example:</p>
110
111<code>
112$word = "my dog spot";<br />
113echo underscore($word); // Returns "my_dog_spot"
114</code>
115
116
117<h2>humanize()</h2>
118
119<p>Takes multiple words separated by underscores and adds spaces between them. Each word is capitalized. Example:</p>
120
121<code>
122$word = "my_dog_spot";<br />
admin592cdcb2006-09-22 18:45:42 +0000123echo humanize($word); // Returns "My Dog Spot"
admine21a7b22006-09-20 23:58:54 +0000124</code>
125
126
127
128
129
130
131
132
133
134
135
136
137</div>
138<!-- END CONTENT -->
139
140
141<div id="footer">
142<p>
143Previous Topic:&nbsp;&nbsp;<a href="../libraries/xmlrpc.html">XML-RPC Class</a>
144&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
145<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
146<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
147Next Topic:&nbsp;&nbsp;<a href="cookie_helper.html">Cookie Helper</a>
148<p>
149<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
150</div>
151
152</body>
153</html>