Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 92bb3e6ad6083b13213c4c3e71d0fbb6a7f83971 / . / user_guide / helpers / inflector_helper.html
blob: 464d129dbc9bc1633fa9d2a60ea723921fc2da05 [file] [log] [blame]
admine21a7b22006-09-20 23:58:54 +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">
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]3<head>
4
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]5<title>Inflector Helper : CodeIgniter User Guide</title>
admine21a7b22006-09-20 23:58:54 +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>
admine21a7b22006-09-20 23:58:54 +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' />
admine21a7b22006-09-20 23:58:54 +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 Jones6b7b11f2008-05-06 16:07:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.2</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>
admine21a7b22006-09-20 23:58:54 +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;
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Inflector 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>
admine21a7b22006-09-20 23:58:54 +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>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
Derek Allard6d1ef222007-03-28 01:26:37 +0000[diff] [blame]74<p>Changes a plural word to singular. Example:</p>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]75
76<code>
77$word = "dogs";<br />
78echo singular($word); // Returns "dog"
79</code>
80
81
82<h2>plural()</h2>
83
Derek Allard6d1ef222007-03-28 01:26:37 +0000[diff] [blame]84<p>Changes a singular word to plural. Example:</p>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]85
86<code>
87$word = "dog";<br />
88echo plural($word); // Returns "dogs"
89</code>
90
91
Derek Allardf5a51982007-07-11 19:35:09 +0000[diff] [blame]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 />
Derek Allard4db34912007-08-08 17:15:17 +0000[diff] [blame]94echo plural($word, TRUE); // Returns &quot;passes&quot; </code>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]95
Derek Allardf5a51982007-07-11 19:35:09 +0000[diff] [blame]96<h2>camelize()</h2>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]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 />
admin592cdcb2006-09-22 18:45:42 +0000[diff] [blame]121echo humanize($word); // Returns "My Dog Spot"
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]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>
Derek Allard9da4dbc2007-04-03 11:39:35 +0000[diff] [blame]141Previous Topic:&nbsp;&nbsp;<a href="html_helper.html"> HTML Helper</a>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]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;
Derek Allard9da4dbc2007-04-03 11:39:35 +0000[diff] [blame]145Next Topic:&nbsp;&nbsp;<a href="security_helper.html">Security Helper</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]146</p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]147<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
admine21a7b22006-09-20 23:58:54 +0000[diff] [blame]148</div>
149
150</body>
151</html>