| Derek Allard | 4bbc5c7 | 2008-01-04 17:00:42 +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> |
| 3 | <head> |
| 4 | |
| 5 | <title>CodeIgniter User Guide : Form Helper</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 | |
| 10 | <script type="text/javascript" src="../nav/nav.js"></script> |
| 11 | <script type="text/javascript" src="../nav/prototype.lite.js"></script> |
| 12 | <script type="text/javascript" src="../nav/moo.fx.js"></script> |
| 13 | <script type="text/javascript" src="../nav/user_guide_menu.js"></script> |
| 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' /> |
| 19 | <meta name='author' content='Rick Ellis' /> |
| 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.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> |
| 31 | <td><h1>CodeIgniter User Guide Version 1.5.4</h1></td> |
| 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://www.codeigniter.com/">CodeIgniter Home</a> › |
| 44 | <a href="../index.html">User Guide Home</a> › |
| 45 | Form 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 <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <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>Form Helper</h1> |
| 60 | |
| 61 | <p>The Form Helper file contains functions that assist in working with forms.</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('form');</code> |
| 68 | |
| 69 | <p>The following functions are available:</p> |
| 70 | |
| 71 | |
| 72 | |
| 73 | <h2>form_open()</h2> |
| 74 | |
| 75 | <p>Creates an opening form tag with a base URL <strong>built from your config preferences</strong>. It will optionally let you |
| 76 | add form attributes and hidden input fields.</p> |
| 77 | |
| 78 | <p>The main benefit of using this tag rather than hard coding your own HTML is that it permits your site to be more portable |
| 79 | in the event your URLs ever change.</p> |
| 80 | |
| 81 | <p>Here's a simple example:</p> |
| 82 | |
| 83 | <code>echo form_open('email/send');</code> |
| 84 | |
| 85 | <p>The above example would create a form that points to your base URL plus the "email/send" URI segments, like this:</p> |
| 86 | |
| 87 | <code><form method="post" action="http:/www.your-site.com/index.php/email/send" /></code> |
| 88 | |
| 89 | <h4>Adding Attributes</h4> |
| 90 | |
| 91 | <p>Attributes can be added by passing an associative array to the second parameter, like this:</p> |
| 92 | |
| 93 | <code> |
| 94 | $attributes = array('class' => 'email', 'id' => 'myform');<br /> |
| 95 | <br /> |
| 96 | echo form_open('email/send', $attributes);</code> |
| 97 | |
| 98 | <p>The above example would create a form similar to this:</p> |
| 99 | |
| 100 | <code><form method="post" action="http:/www.your-site.com/index.php/email/send" class="email" id="myform" /></code> |
| 101 | |
| 102 | <h4>Adding Hidden Input Fields</h4> |
| 103 | |
| 104 | <p>Hidden fields can be added by passing an associative array to the third parameter, like this:</p> |
| 105 | |
| 106 | <code> |
| 107 | $hidden = array('username' => 'Joe', 'member_id' => '234');<br /> |
| 108 | <br /> |
| 109 | echo form_open('email/send', '', $hidden);</code> |
| 110 | |
| 111 | <p>The above example would create a form similar to this:</p> |
| 112 | |
| 113 | <code><form method="post" action="http:/www.your-site.com/index.php/email/send" class="email" id="myform" /><br /> |
| 114 | <input type="hidden" name="username" value="Joe" /><br /> |
| 115 | <input type="hidden" name="member_id" value="234" /></code> |
| 116 | |
| 117 | |
| 118 | <h2>form_open_multipart()</h2> |
| 119 | |
| 120 | <p>This function is absolutely identical to the <dfn>form_open()</dfn> tag above except that it adds a multipart attribute, |
| 121 | which is necessary if you would like to use the form to upload files with.</p> |
| 122 | |
| 123 | <h2>form_hidden()</h2> |
| 124 | |
| 125 | <p>Lets you generate hidden input fields. You can either submit a name/value string to create one field:</p> |
| 126 | |
| 127 | <code>form_hidden('username', 'johndoe');<br /> |
| 128 | <br /> |
| 129 | // Would produce:<br /><br /> |
| 130 | <input type="hidden" name="username" value="johnodoe" /></code> |
| 131 | |
| 132 | <p>Or you can submit an associative array to create multiple fields:</p> |
| 133 | |
| 134 | <code>$data = array(<br /> |
| 135 | 'name' => 'John Doe',<br /> |
| 136 | 'email' => 'john@example.com',<br /> |
| 137 | 'url' => 'http://www.example.com'<br /> |
| 138 | );<br /> |
| 139 | <br /> |
| 140 | echo form_hidden($data);<br /> |
| 141 | <br /> |
| 142 | // Would produce:<br /><br /> |
| 143 | <input type="hidden" name="name" value="John Doe" /><br /> |
| 144 | <input type="hidden" name="email" value="john@example.com" /><br /> |
| 145 | <input type="hidden" name="url" value="http://www.example.com" /></code> |
| 146 | |
| 147 | |
| 148 | |
| 149 | |
| 150 | <h2>form_input()</h2> |
| 151 | |
| 152 | <p>Lets you generate a standard text input field. You can minimally pass the field name and value in the first |
| 153 | and second parameter:</p> |
| 154 | |
| 155 | <code>echo form_input('username', 'johndoe');</code> |
| 156 | |
| 157 | <p>Or you can pass an associative array containing any data you wish your form to contain:</p> |
| 158 | |
| 159 | <code>$data = array(<br /> |
| 160 | 'name' => 'username',<br /> |
| 161 | 'id' => 'username',<br /> |
| 162 | 'value' => 'johndoe',<br /> |
| 163 | 'maxlength' => '100',<br /> |
| 164 | 'size' => '50',<br /> |
| 165 | 'style' => 'width:50%',<br /> |
| 166 | );<br /> |
| 167 | <br /> |
| 168 | echo form_input($data);<br /> |
| 169 | <br /> |
| 170 | // Would produce:<br /><br /> |
| 171 | <input type="text" name="username" id="username" value="johndoe" maxlength="100" size="50" style="width:50%" /></code> |
| 172 | |
| 173 | <p>If you would like your form to contain some additional data, like JavaScript, you can pass it as a string in the |
| 174 | third parameter:</p> |
| 175 | |
| 176 | <code>$js = 'onClick="some_function()"';<br /> |
| 177 | <br /> |
| 178 | echo form_input('username', 'johndoe', $js);</code> |
| 179 | |
| 180 | <h2>form_password()</h2> |
| 181 | |
| 182 | <p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
| 183 | except that is sets it as a "password" type.</p> |
| 184 | |
| 185 | <h2>form_upload()</h2> |
| 186 | |
| 187 | <p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
| 188 | except that is sets it as a "file" type, allowing it to be used to upload files.</p> |
| 189 | |
| 190 | <h2>form_textarea()</h2> |
| 191 | |
| 192 | <p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
| 193 | except that it generates a "textarea" type. Note: Instead of the "maxlength" and "size" attributes in the above |
| 194 | example, you will instead specify "rows" and "cols".</p> |
| 195 | |
| 196 | |
| 197 | <h2>form_dropdown()</h2> |
| 198 | |
| 199 | <p>Lets you create a standard drop-down field. The first parameter will contain the name of the field, |
| 200 | the second parameter will contain an associative array of options, and the third parameter will contain the |
| 201 | value you wish to be selected. Example:</p> |
| 202 | |
| 203 | <code>$options = array(<br /> |
| 204 | 'small' => 'Small Shirt',<br /> |
| 205 | 'med' => 'Medium Shirt',<br /> |
| 206 | 'large' => 'Large Shirt',<br /> |
| 207 | 'xlarge' => 'Extra Large Shirt',<br /> |
| 208 | );<br /> |
| 209 | <br /> |
| 210 | echo form_dropdown('shirts', $options, 'large');<br /> |
| 211 | <br /> |
| 212 | // Would produce:<br /><br /> |
| 213 | |
| 214 | <select name="shirts"><br /> |
| 215 | <option value="small">Small Shirt</option><br /> |
| 216 | <option value="med">Medium Shirt</option><br /> |
| 217 | <option value="large" selected>Large Shirt</option><br /> |
| 218 | <option value="xlarge">Extra Large Shirt</option><br /> |
| 219 | </select></code> |
| 220 | |
| 221 | |
| 222 | <p>If you would like the opening <select> to contain additional data, like JavaScript, you can pass it as a string in the |
| 223 | fourth parameter:</p> |
| 224 | |
| 225 | <code>$js = 'onChange="some_function()"';<br /> |
| 226 | <br /> |
| 227 | echo form_dropdown('shirts', $options, 'large', $js);</code> |
| 228 | |
| 229 | |
| 230 | <h2>form_fieldset()</h2> |
| 231 | |
| 232 | <p>Lets you generate fieldset/legend fields.</p> |
| 233 | <code>echo form_fieldset('Address Information');<br /> |
| 234 | echo "<p>fieldset content here</p>\n";<br /> |
| 235 | echo form_fieldset_close(); |
| 236 | <br /> |
| 237 | <br /> |
| 238 | // Produces<br /> |
| 239 | <fieldset id="address_info"> |
| 240 | <br /> |
| 241 | <legend>Address Information</legend> |
| 242 | <br /> |
| 243 | <p>form content here</p> |
| 244 | <br /> |
| 245 | </fieldset></code> |
| 246 | <p>Similar to other functions, you can submit an associative array in the second parameter if you prefer to set additional attributes. </p> |
| 247 | <p><code>$attributes = array('id' => 'address_info', 'class' => 'address_info');<br /> |
| 248 | echo form_fieldset('Address Information', $attributes);<br /> |
| 249 | echo "<p>fieldset content here</p>\n";<br /> |
| 250 | echo form_fieldset_close(); <br /> |
| 251 | <br /> |
| 252 | // Produces<br /> |
| 253 | <fieldset id="address_info" class="address_info"> <br /> |
| 254 | <legend>Address Information</legend> <br /> |
| 255 | <p>form content here</p> <br /> |
| 256 | </fieldset></code></p> |
| 257 | <h2>form_fieldset_close()</h2> |
| 258 | <p>Produces a closing </fieldset> tag. The only advantage to using this function is it permits you to pass data to it |
| 259 | which will be added below the tag. For example:</p> |
| 260 | <code>$string = "</div></div>";<br /> |
| 261 | <br /> |
| 262 | echo fieldset_close($string);<br /> |
| 263 | <br /> |
| 264 | // Would produce:<br /> |
| 265 | </fieldset><br /> |
| 266 | </div></div></code> |
| 267 | <h2>form_checkbox()</h2> |
| 268 | <p>Lets you generate a checkbox field. Simple example:</p> |
| 269 | <code>echo form_checkbox('newsletter', 'accept', TRUE);<br /> |
| 270 | <br /> |
| 271 | // Would produce:<br /> |
| 272 | <br /> |
| 273 | <input type="checkbox" name="newsletter" value="accept" checked="checked" /></code> |
| 274 | <p>The third parameter contains a boolean TRUE/FALSE to determine whether the box should be checked or not.</p> |
| 275 | <p>Similar to the other form functions in this helper, you can also pass an array of attributes to the function:</p> |
| 276 | |
| 277 | <code>$data = array(<br /> |
| 278 | 'name' => 'newsletter',<br /> |
| 279 | 'id' => 'newsletter',<br /> |
| 280 | 'value' => 'accept',<br /> |
| 281 | 'checked' => TRUE,<br /> |
| 282 | 'style' => 'margin:10px',<br /> |
| 283 | );<br /> |
| 284 | <br /> |
| 285 | echo form_checkbox($data);<br /> |
| 286 | <br /> |
| 287 | // Would produce:<br /><br /> |
| 288 | <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" /></code> |
| 289 | |
| 290 | <p>As with other functions, if you would like the tag to contain additional data, like JavaScript, you can pass it as a string in the |
| 291 | fourth parameter:</p> |
| 292 | |
| 293 | <code>$js = 'onClick="some_function()"';<br /> |
| 294 | <br /> |
| 295 | echo form_checkbox('newsletter', 'accept', TRUE, $js)</code> |
| 296 | |
| 297 | |
| 298 | <h2>form_radio()</h2> |
| 299 | <p>This function is identical in all respects to the <dfn>form_checkbox()</dfn> function above except that is sets it as a "radio" type.</p> |
| 300 | |
| 301 | |
| 302 | <h2>form_submit()</h2> |
| 303 | |
| 304 | <p>Lets you generate a standard submit button. Simple example:</p> |
| 305 | <code>echo form_submit('mysubmit', 'Submit Post!');<br /> |
| 306 | <br /> |
| 307 | // Would produce:<br /> |
| 308 | <br /> |
| 309 | <input type="submit" name="mysubmit" value="Submit Post!" /></code> |
| 310 | <p>Similar to other functions, you can submit an associative array in the first parameter if you prefer to set your own attributes. |
| 311 | The third parameter lets you add extra data to your form, like JavaScript.</p> |
| 312 | <h2>form_label()</h2> |
| 313 | <p>Lets you generate a <label>. Simple example:</p> |
| 314 | <code>echo form_label('What is your Name', 'username');<br /> |
| 315 | <br /> |
| 316 | // Would produce: |
| 317 | <br /> |
| 318 | <label id="username">What is your Name</label></code> |
| 319 | <p>Similar to other functions, you can submit an associative array in the third parameter if you prefer to set additional attributes. </p> |
| 320 | <p><code>$attributes = array(<br /> |
| 321 | 'class' => 'mycustomclass',<br /> |
| 322 | 'style' => 'color: #000;',<br /> |
| 323 | );<br /> |
| 324 | echo form_label('What is your Name', 'username', $attributes);<br /> |
| 325 | <br /> |
| 326 | // Would produce: <br /> |
| 327 | <label id="username" class="mycustomclass" style="color: #000;">What is your Name</label></code></p> |
| 328 | <h2>form_reset()</h2> |
| 329 | |
| 330 | <p>Lets you generate a standard reset button. Use is identical to <dfn>form_submit()</dfn>.</p> |
| 331 | |
| 332 | <h2>form_close()</h2> |
| 333 | |
| 334 | <p>Produces a closing </form> tag. The only advantage to using this function is it permits you to pass data to it |
| 335 | which will be added below the tag. For example:</p> |
| 336 | |
| 337 | <code>$string = "</div></div>";<br /> |
| 338 | <br /> |
| 339 | echo form_close($string);<br /> |
| 340 | <br /> |
| 341 | // Would produce:<br /> |
| 342 | <br /> |
| 343 | </form><br /> |
| 344 | </div></div></code> |
| 345 | |
| 346 | |
| 347 | |
| 348 | |
| 349 | |
| 350 | <h2>form_prep()</h2> |
| 351 | |
| 352 | <p>Allows you to safely use HTML and characters such as quotes within form elements without breaking out of the form. Consider this example:</p> |
| 353 | |
| 354 | <code>$string = 'Here is a string containing <strong>"quoted"</strong> text.';<br /> |
| 355 | <br /> |
| 356 | <input type="text" name="myform" value="<var>$string</var>" /></code> |
| 357 | |
| 358 | <p>Since the above string contains a set of quotes it will cause the form to break. |
| 359 | The form_prep function converts HTML so that it can be used safely:</p> |
| 360 | |
| 361 | <code><input type="text" name="myform" value="<var><?php echo form_prep($string); ?></var>" /></code> |
| 362 | |
| 363 | <p class="important"><strong>Note:</strong> If you use any of the form helper functions listed in this page the form |
| 364 | values will be prepped automatically, so there is no need to call this function. Use it only if you are |
| 365 | creating your own form elements.</p> |
| 366 | |
| 367 | |
| 368 | |
| 369 | |
| 370 | </div> |
| 371 | <!-- END CONTENT --> |
| 372 | |
| 373 | |
| 374 | <div id="footer"> |
| 375 | <p> |
| 376 | Previous Topic: <a href="file_helper.html">File Helper</a> |
| 377 | · |
| 378 | <a href="#top">Top of Page</a> · |
| 379 | <a href="../index.html">User Guide Home</a> · |
| 380 | Next Topic: <a href="html_helper.html">HTML Helper</a> |
| 381 | </p> |
| 382 | <p><a href="http://www.codeigniter.com">CodeIgniter</a> · Copyright © 2007 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> |
| 383 | </div> |
| 384 | |
| 385 | </body> |
| Derek Allard | 402835c | 2008-01-04 14:30:58 +0000 | [diff] [blame] | 386 | </html> |