LineItemsController.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
  1. <!DOCTYPE html>
  2. <!--
  3. ! Excerpted from "Agile Web Development with Rails",
  4. ! published by The Pragmatic Bookshelf.
  5. ! Copyrights apply to this code. It may not be used to create training material,
  6. ! courses, books, articles, and the like. Contact us if you are in doubt.
  7. ! We make no guarantees that this code is fit for any purpose.
  8. ! Visit http://www.pragmaticprogrammer.com/titles/rails4 for more book information.
  9. -->
  10. <html>
  11. <head>
  12. <meta charset="utf-8">
  13. <title>class LineItemsController - Rails Application Documentation</title>
  14. <link href="./fonts.css" rel="stylesheet">
  15. <link href="./rdoc.css" rel="stylesheet">
  16. <script type="text/javascript">
  17. var rdoc_rel_prefix = "./";
  18. </script>
  19. <script src="./js/jquery.js"></script>
  20. <script src="./js/navigation.js"></script>
  21. <script src="./js/search_index.js"></script>
  22. <script src="./js/search.js"></script>
  23. <script src="./js/searcher.js"></script>
  24. <script src="./js/darkfish.js"></script>
  25. <body id="top" role="document" class="class">
  26. <nav role="navigation">
  27. <div id="project-navigation">
  28. <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  29. <h2>
  30. <a href="./index.html" rel="home">Home</a>
  31. </h2>
  32. <div id="table-of-contents-navigation">
  33. <a href="./table_of_contents.html#pages">Pages</a>
  34. <a href="./table_of_contents.html#classes">Classes</a>
  35. <a href="./table_of_contents.html#methods">Methods</a>
  36. </div>
  37. </div>
  38. <div id="search-section" role="search" class="project-section initially-hidden">
  39. <form action="#" method="get" accept-charset="utf-8">
  40. <div id="search-field-wrapper">
  41. <input id="search-field" role="combobox" aria-label="Search"
  42. aria-autocomplete="list" aria-controls="search-results"
  43. type="text" name="search" placeholder="Search" spellcheck="false"
  44. title="Type to search, Up and Down to navigate, Enter to load">
  45. </div>
  46. <ul id="search-results" aria-label="Search Results"
  47. aria-busy="false" aria-expanded="false"
  48. aria-atomic="false" class="initially-hidden"></ul>
  49. </form>
  50. </div>
  51. </div>
  52. <div id="class-metadata">
  53. <div id="parent-class-section" class="nav-section">
  54. <h3>Parent</h3>
  55. <p class="link"><a href="ApplicationController.html">ApplicationController</a>
  56. </div>
  57. <div id="includes-section" class="nav-section">
  58. <h3>Included Modules</h3>
  59. <ul class="link-list">
  60. <li><a class="include" href="CurrentCart.html">CurrentCart</a>
  61. </ul>
  62. </div>
  63. <!-- Method Quickref -->
  64. <div id="method-list-section" class="nav-section">
  65. <h3>Methods</h3>
  66. <ul class="link-list" role="directory">
  67. <li ><a href="#method-i-create">#create</a>
  68. <li ><a href="#method-i-destroy">#destroy</a>
  69. <li ><a href="#method-i-edit">#edit</a>
  70. <li ><a href="#method-i-index">#index</a>
  71. <li ><a href="#method-i-new">#new</a>
  72. <li ><a href="#method-i-show">#show</a>
  73. <li ><a href="#method-i-update">#update</a>
  74. </ul>
  75. </div>
  76. </div>
  77. </nav>
  78. <main role="main" aria-labelledby="class-LineItemsController">
  79. <h1 id="class-LineItemsController" class="class">
  80. class LineItemsController
  81. </h1>
  82. <section class="description">
  83. <p>START:current_cart START:setup</p>
  84. </section>
  85. <section id="5Buntitled-5D" class="documentation-section">
  86. <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
  87. <header>
  88. <h3>Public Instance Methods</h3>
  89. </header>
  90. <div id="method-i-create" class="method-detail ">
  91. <div class="method-heading">
  92. <span class="method-name">create</span><span
  93. class="method-args">()</span>
  94. <span class="method-click-advice">click to toggle source</span>
  95. </div>
  96. <div class="method-description">
  97. <pre>POST /line_items
  98. POST /line_items.json</pre>
  99. <p>START:create</p>
  100. <div class="method-source-code" id="create-source">
  101. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 36</span>
  102. <span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span>
  103. <span class="ruby-identifier">product</span> = <span class="ruby-constant">Product</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:product_id</span>])
  104. <span class="ruby-ivar">@line_item</span> = <span class="ruby-ivar">@cart</span>.<span class="ruby-identifier">add_product</span>(<span class="ruby-identifier">product</span>.<span class="ruby-identifier">id</span>)
  105. <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
  106. <span class="ruby-keyword">if</span> <span class="ruby-ivar">@line_item</span>.<span class="ruby-identifier">save</span>
  107. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">store_url</span> }
  108. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-ivar">@current_item</span> = <span class="ruby-ivar">@line_item</span> }
  109. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:show</span>,
  110. <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:created</span>, <span class="ruby-identifier">location</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@line_item</span> }
  111. <span class="ruby-keyword">else</span>
  112. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:new</span> }
  113. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@line_item</span>.<span class="ruby-identifier">errors</span>,
  114. <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:unprocessable_entity</span> }
  115. <span class="ruby-keyword">end</span>
  116. <span class="ruby-keyword">end</span>
  117. <span class="ruby-keyword">end</span></pre>
  118. </div>
  119. </div>
  120. </div>
  121. <div id="method-i-destroy" class="method-detail ">
  122. <div class="method-heading">
  123. <span class="method-name">destroy</span><span
  124. class="method-args">()</span>
  125. <span class="method-click-advice">click to toggle source</span>
  126. </div>
  127. <div class="method-description">
  128. <p>DELETE /line_items/1 DELETE /line_items/1.json</p>
  129. <div class="method-source-code" id="destroy-source">
  130. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 73</span>
  131. <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
  132. <span class="ruby-ivar">@line_item</span>.<span class="ruby-identifier">destroy</span>
  133. <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
  134. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">line_items_url</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;Line item was successfully destroyed.&#39;</span> }
  135. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">head</span> <span class="ruby-value">:no_content</span> }
  136. <span class="ruby-keyword">end</span>
  137. <span class="ruby-keyword">end</span></pre>
  138. </div>
  139. </div>
  140. </div>
  141. <div id="method-i-edit" class="method-detail ">
  142. <div class="method-heading">
  143. <span class="method-name">edit</span><span
  144. class="method-args">()</span>
  145. <span class="method-click-advice">click to toggle source</span>
  146. </div>
  147. <div class="method-description">
  148. <p>GET /line_items/1/edit</p>
  149. <div class="method-source-code" id="edit-source">
  150. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 30</span>
  151. <span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span>
  152. <span class="ruby-keyword">end</span></pre>
  153. </div>
  154. </div>
  155. </div>
  156. <div id="method-i-index" class="method-detail ">
  157. <div class="method-heading">
  158. <span class="method-name">index</span><span
  159. class="method-args">()</span>
  160. <span class="method-click-advice">click to toggle source</span>
  161. </div>
  162. <div class="method-description">
  163. <pre>GET /line_items</pre>
  164. <p>END:current_cart</p>
  165. <pre>GET /line_items.json</pre>
  166. <div class="method-source-code" id="index-source">
  167. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 15</span>
  168. <span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span>
  169. <span class="ruby-ivar">@line_items</span> = <span class="ruby-constant">LineItem</span>.<span class="ruby-identifier">all</span>
  170. <span class="ruby-keyword">end</span></pre>
  171. </div>
  172. </div>
  173. </div>
  174. <div id="method-i-new" class="method-detail ">
  175. <div class="method-heading">
  176. <span class="method-name">new</span><span
  177. class="method-args">()</span>
  178. <span class="method-click-advice">click to toggle source</span>
  179. </div>
  180. <div class="method-description">
  181. <p>GET /line_items/new</p>
  182. <div class="method-source-code" id="new-source">
  183. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 25</span>
  184. <span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span>
  185. <span class="ruby-ivar">@line_item</span> = <span class="ruby-constant">LineItem</span>.<span class="ruby-identifier">new</span>
  186. <span class="ruby-keyword">end</span></pre>
  187. </div>
  188. </div>
  189. </div>
  190. <div id="method-i-show" class="method-detail ">
  191. <div class="method-heading">
  192. <span class="method-name">show</span><span
  193. class="method-args">()</span>
  194. <span class="method-click-advice">click to toggle source</span>
  195. </div>
  196. <div class="method-description">
  197. <p>GET /line_items/1 GET /line_items/1.json</p>
  198. <div class="method-source-code" id="show-source">
  199. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 21</span>
  200. <span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span>
  201. <span class="ruby-keyword">end</span></pre>
  202. </div>
  203. </div>
  204. </div>
  205. <div id="method-i-update" class="method-detail ">
  206. <div class="method-heading">
  207. <span class="method-name">update</span><span
  208. class="method-args">()</span>
  209. <span class="method-click-advice">click to toggle source</span>
  210. </div>
  211. <div class="method-description">
  212. <p>PATCH/PUT /line_items/1 PATCH/PUT /line_items/1.json</p>
  213. <div class="method-source-code" id="update-source">
  214. <pre><span class="ruby-comment"># File app/controllers/line_items_controller.rb, line 59</span>
  215. <span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>
  216. <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
  217. <span class="ruby-keyword">if</span> <span class="ruby-ivar">@line_item</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">line_item_params</span>)
  218. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-ivar">@line_item</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;Line item was successfully updated.&#39;</span> }
  219. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:show</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:ok</span>, <span class="ruby-identifier">location</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@line_item</span> }
  220. <span class="ruby-keyword">else</span>
  221. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:edit</span> }
  222. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@line_item</span>.<span class="ruby-identifier">errors</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:unprocessable_entity</span> }
  223. <span class="ruby-keyword">end</span>
  224. <span class="ruby-keyword">end</span>
  225. <span class="ruby-keyword">end</span></pre>
  226. </div>
  227. </div>
  228. </div>
  229. </section>
  230. </section>
  231. </main>
  232. <footer id="validator-badges" role="contentinfo">
  233. <p><a href="http://validator.w3.org/check/referer">Validate</a>
  234. <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
  235. <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
  236. </footer>