vendor/rails/railties/doc/guides/html/form_helpers.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
   3 <head>
   4         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   5         <title>Rails form helpers</title>
   6         <!--[if lt IE 8]>
   7         <script src="http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE8.js" type="text/javascript"></script>
   8         <![endif]-->
   9         <link href="stylesheets/base.css" media="screen" rel="Stylesheet" type="text/css" />
  10         <link href="stylesheets/forms.css" media="screen" rel="Stylesheet" type="text/css" />
  11         <link href="stylesheets/more.css" media="screen" rel="Stylesheet" type="text/css" />
  12         <style type="text/css">
  13                 div#container {
  14         max-width: 900px;
  15         padding-bottom: 3em;
  16 }
  17
  18 div#content {
  19         margin-left: 200px;
  20 }
  21
  22 div#container.notoc {
  23         max-width: 600px;
  24 }
  25
  26 .notoc div#content {
  27         margin-left: 0;
  28 }
  29
  30 pre {
  31         line-height: 1.4em;
  32 }
  33
  34 #content p tt {
  35         background: #eeeeee;
  36         border: solid 1px #cccccc;
  37         padding: 3px;
  38 }
  39
  40 dt {
  41         font-weight: bold;
  42 }
  43
  44 #content dt tt {
  45         font-size: 10pt;
  46 }
  47
  48 dd {
  49         margin-left: 3em;
  50 }
  51
  52 #content dt tt, #content pre tt {
  53         background: none;
  54         padding: 0;
  55         border: 0;
  56 }
  57
  58 #content .olist ol {
  59         margin-left: 2em;
  60 }
  61
  62 #header {
  63         position: relative;
  64         max-width: 840px;
  65         margin-left: auto;
  66         margin-right: auto;
  67 }
  68
  69 #header.notoc {
  70         max-width: 580px;
  71 }
  72
  73 #logo {
  74         position: absolute;
  75         left: 10px;
  76         top: 10px;
  77         width: 110px;
  78         height: 140px;
  79 }
  80
  81 div#header h1#site_title {
  82         background: url('images/ruby_on_rails_by_mike_rundle2.gif') top left no-repeat;
  83         position: absolute;
  84         width: 392px;
  85         height: 55px;
  86         left: 145px;
  87         top: 20px;
  88         margin: 0;
  89         padding: 0;
  90 }
  91
  92 #site_title span {
  93         display: none;
  94 }
  95
  96 #site_title_tagline {
  97         display: none;
  98 }
  99
 100 ul#navMain {
 101         position: absolute;
 102         margin: 0;
 103         padding: 0;
 104         top: 97px;
 105         left: 145px;
 106 }
 107
 108 .left-floaty, .right-floaty {
 109         padding: 15px;
 110 }
 111
 112 .admonitionblock,
 113 .tableblock {
 114         margin-left: 1em;
 115         margin-right: 1em;
 116         margin-top: 0.25em;
 117         margin-bottom: 1em;
 118 }
 119
 120 .admonitionblock .icon {
 121         padding-right: 8px;
 122 }
 123
 124 .admonitionblock .content {
 125         border: solid 1px #ffda78;
 126         background: #fffebd;
 127         padding: 10px;
 128         padding-top: 8px;
 129         padding-bottom: 8px;
 130 }
 131
 132 .admonitionblock .title {
 133         font-size: 140%;
 134         margin-bottom: 0.5em;
 135 }
 136
 137 .tableblock table {
 138         border: solid 1px #aaaaff;
 139         background: #f0f0ff;
 140 }
 141
 142 .tableblock th {
 143         background: #e0e0e0;
 144 }
 145
 146 .tableblock th,
 147 .tableblock td {
 148         padding: 3px;
 149         padding-left: 5px;
 150         padding-right: 5px;
 151 }
 152
 153 .sidebarblock {
 154         margin-top: 0.25em;
 155         margin: 1em;
 156         border: solid 1px #ccccbb;
 157         padding: 8px;
 158         background: #ffffe0;
 159 }
 160
 161 .sidebarblock .sidebar-title {
 162         font-size: 140%;
 163         font-weight: 600;
 164         margin-bottom: 0.3em;
 165 }
 166
 167 .sidebarblock .sidebar-content > .para:last-child > p {
 168         margin-bottom: 0;
 169 }
 170
 171 .sidebarblock .sidebar-title a {
 172         text-decoration: none;
 173 }
 174
 175 .sidebarblock .sidebar-title a:hover {
 176         text-decoration: underline;
 177 }
 178
 179         </style>
 180 </head>
 181 <body>
 182         <div id="header" >
 183                 <div id="logo">
 184                         <a href="index.html" title="Ruby on Rails"><img src="images/rails_logo_remix.gif" alt="Rails" height="140" width="110" /></a>
 185                 </div>
 186
 187                 <h1 id="site_title"><span>Ruby on Rails</span></h1>
 188                 <h2 id="site_title_tagline">Sustainable productivity for web-application development</h2>
 189
 190                 <ul id="navMain">
 191                         <li class="first-child"><a href="http://www.rubyonrails.org/" title="Ruby on Rails" class="ruby_on_rails">Ruby on Rails</a></li>
 192                         <li><a class="manuals" href="index.html" title="Manuals Index">Guides Index</a></li>
 193                 </ul>
 194         </div>
 195
 196         <div id="container">
 197
 198                 <div id="sidebar">
 199                         <h2>Chapters</h2>
 200                         <ol>
 201                                         <li>
 202                                         <a href="#_basic_forms">Basic forms</a>
 203                                                 <ul>
 204
 205                                                         <li><a href="#_generic_search_form">Generic search form</a></li>
 206
 207                                                         <li><a href="#_multiple_hashes_in_form_helper_attributes">Multiple hashes in form helper attributes</a></li>
 208
 209                                                         <li><a href="#_checkboxes_radio_buttons_and_other_controls">Checkboxes, radio buttons and other controls</a></li>
 210
 211                                                         <li><a href="#_how_do_forms_with_put_or_delete_methods_work">How do forms with PUT or DELETE methods work?</a></li>
 212
 213                                                 </ul>
 214                                         </li>
 215                                         <li>
 216                                         <a href="#_forms_that_deal_with_model_attributes">Forms that deal with model attributes</a>
 217                                                 <ul>
 218
 219                                                         <li><a href="#_relying_on_record_identification">Relying on record identification</a></li>
 220
 221                                                 </ul>
 222                                         </li>
 223                                         <li>
 224                                         <a href="#_making_select_boxes_with_ease">Making select boxes with ease</a>
 225                                                 <ul>
 226
 227                                                         <li><a href="#_the_select_tag_and_options">The select tag and options</a></li>
 228
 229                                                         <li><a href="#_select_boxes_for_dealing_with_models">Select boxes for dealing with models</a></li>
 230
 231                                                 </ul>
 232                                         </li>
 233                         </ol>
 234                 </div>
 235
 236                 <div id="content">
 237                                 <h1>Rails form helpers</h1>
 238                         <div id="preamble">
 239 <div class="sectionbody">
 240 <div class="para"><p>Forms in web applications are an essential interface for user input. However, form markup can quickly become tedious to write and maintain because of form control naming and their numerous attributes. Rails deals away with these complexities by providing view helpers for generating form markup. However, since they have different use-cases, developers are required to know all the differences between similar helper methods before putting them to use.</p></div>
 241 <div class="para"><p>In this guide we will:</p></div>
 242 <div class="ilist"><ul>
 243 <li>
 244 <p>
 245 Create search forms and similar kind of generic forms not representing any specific model in your application;
 246 </p>
 247 </li>
 248 <li>
 249 <p>
 250 Make model-centric forms for creation and editing of specific database records;
 251 </p>
 252 </li>
 253 <li>
 254 <p>
 255 Generate select boxes from multiple types of data;
 256 </p>
 257 </li>
 258 <li>
 259 <p>
 260 Learn what makes a file upload form different;
 261 </p>
 262 </li>
 263 <li>
 264 <p>
 265 Build complex, multi-model forms.
 266 </p>
 267 </li>
 268 </ul></div>
 269 <div class="admonitionblock">
 270 <table><tr>
 271 <td class="icon">
 272 <img src="./images/icons/note.png" alt="Note" />
 273 </td>
 274 <td class="content">This guide is not intended to be a complete documentation of available form helpers and their arguments. Please visit <a href="http://api.rubyonrails.org/">the Rails API documentation</a> for a complete reference.</td>
 275 </tr></table>
 276 </div>
 277 </div>
 278 </div>
 279 <h2 id="_basic_forms">1. Basic forms</h2>
 280 <div class="sectionbody">
 281 <div class="para"><p>The most basic form helper is <tt>form_tag</tt>.</p></div>
 282 <div class="listingblock">
 283 <div class="content">
 284 <pre><tt>&lt;% form_tag do %&gt;
 285   Form contents
 286 &lt;% end %&gt;</tt></pre>
 287 </div></div>
 288 <div class="para"><p>When called without arguments like this, it creates a form element that has the current page for action attribute and "POST" as method (some line breaks added for readability):</p></div>
 289 <div class="listingblock">
 290 <div class="title">Example: Sample rendering of <tt>form_tag</tt></div>
 291 <div class="content">
 292 <pre><tt>&lt;form action="/home/index" method="post"&gt;
 293   &lt;div style="margin:0;padding:0"&gt;
 294     &lt;input name="authenticity_token" type="hidden" value="f755bb0ed134b76c432144748a6d4b7a7ddf2b71" /&gt;
 295   &lt;/div&gt;
 296   Form contents
 297 &lt;/form&gt;</tt></pre>
 298 </div></div>
 299 <div class="para"><p>If you carefully observe this output, you can see that the helper generated something we didn't specify: a <tt>div</tt> element with a hidden input inside. This is a security feature of Rails called <strong>cross-site request forgery protection</strong> and form helpers generate it for every form which action isn't "GET" (provided that this security feature is enabled).</p></div>
 300 <div class="admonitionblock">
 301 <table><tr>
 302 <td class="icon">
 303 <img src="./images/icons/note.png" alt="Note" />
 304 </td>
 305 <td class="content">Throughout this guide, this <tt>div</tt> with the hidden input will be stripped away to have clearer code samples.</td>
 306 </tr></table>
 307 </div>
 308 <h3 id="_generic_search_form">1.1. Generic search form</h3>
 309 <div class="para"><p>Probably the most minimal form often seen on the web is a search form with a single text input for search terms. This form consists of:</p></div>
 310 <div class="olist"><ol>
 311 <li>
 312 <p>
 313 a form element with "GET" method,
 314 </p>
 315 </li>
 316 <li>
 317 <p>
 318 a label for the input,
 319 </p>
 320 </li>
 321 <li>
 322 <p>
 323 a text input element, and
 324 </p>
 325 </li>
 326 <li>
 327 <p>
 328 a submit element.
 329 </p>
 330 </li>
 331 </ol></div>
 332 <div class="admonitionblock">
 333 <table><tr>
 334 <td class="icon">
 335 <img src="./images/icons/important.png" alt="Important" />
 336 </td>
 337 <td class="content">Always use "GET" as the method for search forms. Benefits are many: users are able to bookmark a specific search and get back to it; browsers cache results of "GET" requests, but not "POST"; and other.</td>
 338 </tr></table>
 339 </div>
 340 <div class="para"><p>To create that, we will use <tt>form_tag</tt>, <tt>label_tag</tt>, <tt>text_field_tag</tt> and <tt>submit_tag</tt>, respectively.</p></div>
 341 <div class="listingblock">
 342 <div class="title">Example: A basic search form</div>
 343 <div class="content">
 344 <pre><tt>&lt;% form_tag(search_path, :method =&gt; "get") do %&gt;
 345   &lt;%= label_tag(:q, "Search for:") %&gt;
 346   &lt;%= text_field_tag(:q) %&gt;
 347   &lt;%= submit_tag("Search") %&gt;
 348 &lt;% end %&gt;</tt></pre>
 349 </div></div>
 350 <div class="admonitionblock">
 351 <table><tr>
 352 <td class="icon">
 353 <img src="./images/icons/tip.png" alt="Tip" />
 354 </td>
 355 <td class="content">
 356 <div class="para"><p><tt>search_path</tt> can be a named route specified in "routes.rb":</p></div>
 357 <div class="listingblock">
 358 <div class="content">
 359 <pre><tt>map.search "search", :controller =&gt; "search"</tt></pre>
 360 </div></div>
 361 </td>
 362 </tr></table>
 363 </div>
 364 <div class="para"><p>The above view code will result in the following markup:</p></div>
 365 <div class="listingblock">
 366 <div class="title">Example: Search form HTML</div>
 367 <div class="content">
 368 <pre><tt>&lt;form action="/search" method="get"&gt;
 369   &lt;label for="q"&gt;Search for:&lt;/label&gt;
 370   &lt;input id="q" name="q" type="text" /&gt;
 371   &lt;input name="commit" type="submit" value="Search" /&gt;
 372 &lt;/form&gt;</tt></pre>
 373 </div></div>
 374 <div class="para"><p>Besides <tt>text_field_tag</tt> and <tt>submit_tag</tt>, there is a similar helper for <em>every</em> form control in HTML.</p></div>
 375 <div class="admonitionblock">
 376 <table><tr>
 377 <td class="icon">
 378 <img src="./images/icons/tip.png" alt="Tip" />
 379 </td>
 380 <td class="content">For every form input, an ID attribute is generated from its name ("q" in our example). These IDs can be very useful for CSS styling or manipulation of form controls with JavaScript.</td>
 381 </tr></table>
 382 </div>
 383 <h3 id="_multiple_hashes_in_form_helper_attributes">1.2. Multiple hashes in form helper attributes</h3>
 384 <div class="para"><p>By now we've seen that the <tt>form_tag</tt> helper accepts 2 arguments: the path for the action attribute and an options hash for parameters (like <tt>:method</tt>).</p></div>
 385 <div class="para"><p>Identical to the <tt>link_to</tt> helper, the path argument doesn't have to be given as string or a named route. It can be a hash of URL parameters that Rails' routing mechanism will turn into a valid URL. Still, we cannot simply write this:</p></div>
 386 <div class="listingblock">
 387 <div class="title">Example: A bad way to pass multiple hashes as method arguments</div>
 388 <div class="content">
 389 <pre><tt>form_tag(:controller =&gt; "people", :action =&gt; "search", :method =&gt; "get")
 390 # =&gt; &lt;form action="/people/search?method=get" method="post"&gt;</tt></pre>
 391 </div></div>
 392 <div class="para"><p>Here we wanted to pass two hashes, but the Ruby interpreter sees only one hash, so Rails will construct a URL that we didn't want. The solution is to delimit the first hash (or both hashes) with curly brackets:</p></div>
 393 <div class="listingblock">
 394 <div class="title">Example: The correct way of passing multiple hashes as arguments</div>
 395 <div class="content">
 396 <pre><tt>form_tag({:controller =&gt; "people", :action =&gt; "search"}, :method =&gt; "get")
 397 # =&gt; &lt;form action="/people/search" method="get"&gt;</tt></pre>
 398 </div></div>
 399 <div class="para"><p>This is a common pitfall when using form helpers, since many of them accept multiple hashes. So in future, if a helper produces unexpected output, make sure that you have delimited the hash parameters properly.</p></div>
 400 <div class="admonitionblock">
 401 <table><tr>
 402 <td class="icon">
 403 <img src="./images/icons/warning.png" alt="Warning" />
 404 </td>
 405 <td class="content">Do not delimit the second hash without doing so with the first hash, otherwise your method invocation will result in an <tt>expecting tASSOC</tt> syntax error.</td>
 406 </tr></table>
 407 </div>
 408 <h3 id="_checkboxes_radio_buttons_and_other_controls">1.3. Checkboxes, radio buttons and other controls</h3>
 409 <div class="para"><p>Checkboxes are form controls that give the user a set of options they can enable or disable:</p></div>
 410 <div class="listingblock">
 411 <div class="content">
 412 <pre><tt>&lt;%= check_box_tag(:pet_dog) %&gt;
 413   &lt;%= label_tag(:pet_dog, "I own a dog") %&gt;
 414 &lt;%= check_box_tag(:pet_cat) %&gt;
 415   &lt;%= label_tag(:pet_cat, "I own a cat") %&gt;
 416
 417 output:
 418
 419 &lt;input id="pet_dog" name="pet_dog" type="checkbox" value="1" /&gt;
 420   &lt;label for="pet_dog"&gt;I own a dog&lt;/label&gt;
 421 &lt;input id="pet_cat" name="pet_cat" type="checkbox" value="1" /&gt;
 422   &lt;label for="pet_cat"&gt;I own a cat&lt;/label&gt;</tt></pre>
 423 </div></div>
 424 <div class="para"><p>Radio buttons, while similar to checkboxes, are controls that specify a set of options in which they are mutually exclusive (user can only pick one):</p></div>
 425 <div class="listingblock">
 426 <div class="content">
 427 <pre><tt>&lt;%= radio_button_tag(:age, "child") %&gt;
 428   &lt;%= label_tag(:age_child, "I am younger than 21") %&gt;
 429 &lt;%= radio_button_tag(:age, "adult") %&gt;
 430   &lt;%= label_tag(:age_adult, "I'm over 21") %&gt;
 431
 432 output:
 433
 434 &lt;input id="age_child" name="age" type="radio" value="child" /&gt;
 435   &lt;label for="age_child"&gt;I am younger than 21&lt;/label&gt;
 436 &lt;input id="age_adult" name="age" type="radio" value="adult" /&gt;
 437   &lt;label for="age_adult"&gt;I'm over 21&lt;/label&gt;</tt></pre>
 438 </div></div>
 439 <div class="admonitionblock">
 440 <table><tr>
 441 <td class="icon">
 442 <img src="./images/icons/important.png" alt="Important" />
 443 </td>
 444 <td class="content">Always use labels for each checkbox and radio button. They associate text with a specific option and provide a larger clickable region.</td>
 445 </tr></table>
 446 </div>
 447 <div class="para"><p>Other form controls we might mention are the text area, password input and hidden input:</p></div>
 448 <div class="listingblock">
 449 <div class="content">
 450 <pre><tt>&lt;%= text_area_tag(:message, "Hi, nice site", :size =&gt; "24x6") %&gt;
 451 &lt;%= password_field_tag(:password) %&gt;
 452 &lt;%= hidden_field_tag(:parent_id, "5") %&gt;
 453
 454 output:
 455
 456 &lt;textarea id="message" name="message" cols="24" rows="6"&gt;Hi, nice site&lt;/textarea&gt;
 457 &lt;input id="password" name="password" type="password" /&gt;
 458 &lt;input id="parent_id" name="parent_id" type="hidden" value="5" /&gt;</tt></pre>
 459 </div></div>
 460 <div class="para"><p>Hidden inputs are not shown to the user, but they hold data same as any textual input. Values inside them can be changed with JavaScript.</p></div>
 461 <div class="admonitionblock">
 462 <table><tr>
 463 <td class="icon">
 464 <img src="./images/icons/tip.png" alt="Tip" />
 465 </td>
 466 <td class="content">If you're using password input fields (for any purpose), you might want to prevent their values showing up in application logs by activating <tt>filter_parameter_logging(:password)</tt> in your ApplicationController.</td>
 467 </tr></table>
 468 </div>
 469 <h3 id="_how_do_forms_with_put_or_delete_methods_work">1.4. How do forms with PUT or DELETE methods work?</h3>
 470 <div class="para"><p>Rails framework encourages RESTful design of your applications, which means you'll be making a lot of "PUT" and "DELETE" requests (besides "GET" and "POST"). Still, most browsers <em>don't support</em> methods other than "GET" and "POST" when it comes to submitting forms. How does this work, then?</p></div>
 471 <div class="para"><p>Rails works around this issue by emulating other methods over POST with a hidden input named <tt>"_method"</tt> that is set to reflect the wanted method:</p></div>
 472 <div class="listingblock">
 473 <div class="content">
 474 <pre><tt>form_tag(search_path, :method =&gt; "put")
 475
 476 output:
 477
 478 &lt;form action="/search" method="post"&gt;
 479   &lt;div style="margin:0;padding:0"&gt;
 480     &lt;input name="_method" type="hidden" value="put" /&gt;
 481     &lt;input name="authenticity_token" type="hidden" value="f755bb0ed134b76c432144748a6d4b7a7ddf2b71" /&gt;
 482   &lt;/div&gt;
 483   ...</tt></pre>
 484 </div></div>
 485 <div class="para"><p>When parsing POSTed data, Rails will take into account the special <tt>"_method"</tt> parameter and act as if the HTTP method was the one specified inside it ("PUT" in this example).</p></div>
 486 </div>
 487 <h2 id="_forms_that_deal_with_model_attributes">2. Forms that deal with model attributes</h2>
 488 <div class="sectionbody">
 489 <div class="para"><p>When we're dealing with an actual model, we will use a different set of form helpers and have Rails take care of some details in the background. In the following examples we will handle an Article model. First, let us have the controller create one:</p></div>
 490 <div class="listingblock">
 491 <div class="title">Example: articles_controller.rb</div>
 492 <div class="content">
 493 <pre><tt>def new
 494   @article = Article.new
 495 end</tt></pre>
 496 </div></div>
 497 <div class="para"><p>Now we switch to the view. The first thing to remember is that we should use <tt>form_for</tt> helper instead of <tt>form_tag</tt>, and that we should pass the model name and object as arguments:</p></div>
 498 <div class="listingblock">
 499 <div class="title">Example: articles/new.html.erb</div>
 500 <div class="content">
 501 <pre><tt>&lt;% form_for :article, @article, :url =&gt; { :action =&gt; "create" } do |f| %&gt;
 502   &lt;%= f.text_field :title %&gt;
 503   &lt;%= f.text_area :body, :size =&gt; "60x12" %&gt;
 504   &lt;%= submit_tag "Create" %&gt;
 505 &lt;% end %&gt;</tt></pre>
 506 </div></div>
 507 <div class="para"><p>There are a few things to note here:</p></div>
 508 <div class="olist"><ol>
 509 <li>
 510 <p>
 511 <tt>:article</tt> is the name of the model and <tt>@article</tt> is our record.
 512 </p>
 513 </li>
 514 <li>
 515 <p>
 516 The URL for the action attribute is passed as a parameter named <tt>:url</tt>.
 517 </p>
 518 </li>
 519 <li>
 520 <p>
 521 The <tt>form_for</tt> method yields <strong>a form builder</strong> object (the <tt>f</tt> variable).
 522 </p>
 523 </li>
 524 <li>
 525 <p>
 526 Methods to create form controls are called <strong>on</strong> the form builder object <tt>f</tt> and <strong>without</strong> the <tt>"_tag"</tt> suffix (so <tt>text_field_tag</tt> becomes <tt>f.text_field</tt>).
 527 </p>
 528 </li>
 529 </ol></div>
 530 <div class="para"><p>The resulting HTML is:</p></div>
 531 <div class="listingblock">
 532 <div class="content">
 533 <pre><tt>&lt;form action="/articles/create" method="post"&gt;
 534   &lt;input id="article_title" name="article[title]" size="30" type="text" /&gt;
 535   &lt;textarea id="article_body" name="article[body]" cols="60" rows="12"&gt;&lt;/textarea&gt;
 536   &lt;input name="commit" type="submit" value="Create" /&gt;
 537 &lt;/form&gt;</tt></pre>
 538 </div></div>
 539 <div class="para"><p>A nice thing about <tt>f.text_field</tt> and other helper methods is that they will pre-fill the form control with the value read from the corresponding attribute in the model. For example, if we created the article instance by supplying an initial value for the title in the controller:</p></div>
 540 <div class="listingblock">
 541 <div class="content">
 542 <pre><tt>@article = Article.new(:title =&gt; "Rails makes forms easy")</tt></pre>
 543 </div></div>
 544 <div class="para"><p>&#8230; the corresponding input will be rendered with a value:</p></div>
 545 <div class="listingblock">
 546 <div class="content">
 547 <pre><tt>&lt;input id="post_title" name="post[title]" size="30" type="text" value="Rails makes forms easy" /&gt;</tt></pre>
 548 </div></div>
 549 <h3 id="_relying_on_record_identification">2.1. Relying on record identification</h3>
 550 <div class="para"><p>In the previous chapter we handled the Article model. This model is directly available to users of our application and, following the best practices for developing with Rails, we should declare it <strong>a resource</strong>.</p></div>
 551 <div class="para"><p>When dealing with RESTful resources, our calls to <tt>form_for</tt> can get significantly easier if we rely on <strong>record identification</strong>. In short, we can just pass the model instance and have Rails figure out model name and the rest:</p></div>
 552 <div class="listingblock">
 553 <div class="content">
 554 <pre><tt>## Creating a new article
 555 # long-style:
 556 form_for(:article, @article, :url =&gt; articles_path)
 557 # same thing, short-style (record identification gets used):
 558 form_for(@article)
 559
 560 ## Editing an existing article
 561 # long-style:
 562 form_for(:article, @article, :url =&gt; article_path(@article), :method =&gt; "put")
 563 # short-style:
 564 form_for(@article)</tt></pre>
 565 </div></div>
 566 <div class="para"><p>Notice how the short-style <tt>form_for</tt> invocation is conveniently the same, regardless of the record being new or existing. Record identification is smart enough to figure out if the record is new by asking <tt>record.new_record?</tt>.</p></div>
 567 <div class="admonitionblock">
 568 <table><tr>
 569 <td class="icon">
 570 <img src="./images/icons/warning.png" alt="Warning" />
 571 </td>
 572 <td class="content">When you're using STI (single-table inheritance) with your models, you can't rely on record identification on a subclass if only their parent class is declared a resource. You will have to specify the model name, <tt>:url</tt> and <tt>:method</tt> explicitly.</td>
 573 </tr></table>
 574 </div>
 575 </div>
 576 <h2 id="_making_select_boxes_with_ease">3. Making select boxes with ease</h2>
 577 <div class="sectionbody">
 578 <div class="para"><p>Select boxes in HTML require a significant amount of markup (one <tt>OPTION</tt> element for each option to choose from), therefore it makes the most sense for them to be dynamically generated from data stored in arrays or hashes.</p></div>
 579 <div class="para"><p>Here is what our wanted markup might look like:</p></div>
 580 <div class="listingblock">
 581 <div class="content">
 582 <pre><tt>&lt;select name="city_id" id="city_id"&gt;
 583   &lt;option value="1"&gt;Lisabon&lt;/option&gt;
 584   &lt;option value="2"&gt;Madrid&lt;/option&gt;
 585   ...
 586   &lt;option value="12"&gt;Berlin&lt;/option&gt;
 587 &lt;/select&gt;</tt></pre>
 588 </div></div>
 589 <div class="para"><p>Here we have a list of cities where their names are presented to the user, but internally we want to handle just their IDs so we keep them in value attributes. Let's see how Rails can help out here.</p></div>
 590 <h3 id="_the_select_tag_and_options">3.1. The select tag and options</h3>
 591 <div class="para"><p>The most generic helper is <tt>select_tag</tt>, which &#8212; as the name implies &#8212; simply generates the <tt>SELECT</tt> tag that encapsulates the options:</p></div>
 592 <div class="listingblock">
 593 <div class="content">
 594 <pre><tt>&lt;%= select_tag(:city_id, '&lt;option value="1"&gt;Lisabon&lt;/option&gt;...') %&gt;</tt></pre>
 595 </div></div>
 596 <div class="para"><p>This is a start, but it doesn't dynamically create our option tags. We had to pass them in as a string.</p></div>
 597 <div class="para"><p>We can generate option tags with the <tt>options_for_select</tt> helper:</p></div>
 598 <div class="listingblock">
 599 <div class="content">
 600 <pre><tt>&lt;%= options_for_select([['Lisabon', 1], ['Madrid', 2], ...]) %&gt;
 601
 602 output:
 603
 604 &lt;option value="1"&gt;Lisabon&lt;/option&gt;
 605 &lt;option value="2"&gt;Madrid&lt;/option&gt;
 606 ...</tt></pre>
 607 </div></div>
 608 <div class="para"><p>For input data we used a nested array where each element has two elements: visible value (name) and internal value (ID).</p></div>
 609 <div class="para"><p>Now you can combine <tt>select_tag</tt> and <tt>options_for_select</tt> to achieve the desired, complete markup:</p></div>
 610 <div class="listingblock">
 611 <div class="content">
 612 <pre><tt>&lt;%= select_tag(:city_id, options_for_select(...)) %&gt;</tt></pre>
 613 </div></div>
 614 <div class="para"><p>Sometimes, depending on our application's needs, we also wish a specific option to be pre-selected. The <tt>options_for_select</tt> helper supports this with an optional second argument:</p></div>
 615 <div class="listingblock">
 616 <div class="content">
 617 <pre><tt>&lt;%= options_for_select(cities_array, 2) %&gt;
 618
 619 output:
 620
 621 &lt;option value="1"&gt;Lisabon&lt;/option&gt;
 622 &lt;option value="2" selected="selected"&gt;Madrid&lt;/option&gt;
 623 ...</tt></pre>
 624 </div></div>
 625 <div class="para"><p>So whenever Rails sees that the internal value of an option being generated matches this value, it will add the <tt>selected</tt> attribute to that option.</p></div>
 626 <h3 id="_select_boxes_for_dealing_with_models">3.2. Select boxes for dealing with models</h3>
 627 <div class="para"><p>Until now we've covered how to make generic select boxes, but in most cases our form controls will be tied to a specific database model. So, to continue from our previous examples, let's assume that we have a "Person" model with a <tt>city_id</tt> attribute.</p></div>
 628 <div class="listingblock">
 629 <div class="content">
 630 <pre><tt>...</tt></pre>
 631 </div></div>
 632 <div class="para"><p>&#8230;</p></div>
 633 </div>
 634
 635                 </div>
 636         </div>
 637 </body>
 638 </html>