OrdersController.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428
  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 OrdersController - 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-OrdersController">
  79. <h1 id="class-OrdersController" class="class">
  80. class OrdersController
  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 /orders
  98. POST /orders.json</pre>
  99. <p>START:create START:create</p>
  100. <div class="method-source-code" id="create-source">
  101. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 42</span>
  102. <span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span>
  103. <span class="ruby-ivar">@order</span> = <span class="ruby-constant">Order</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">order_params</span>)
  104. <span class="ruby-ivar">@order</span>.<span class="ruby-identifier">add_line_items_from_cart</span>(<span class="ruby-ivar">@cart</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">@order</span>.<span class="ruby-identifier">save</span>
  107. <span class="ruby-constant">Cart</span>.<span class="ruby-identifier">destroy</span>(<span class="ruby-identifier">session</span>[<span class="ruby-value">:cart_id</span>])
  108. <span class="ruby-identifier">session</span>[<span class="ruby-value">:cart_id</span>] = <span class="ruby-keyword">nil</span>
  109. <span class="ruby-constant">OrderNotifier</span>.<span class="ruby-identifier">received</span>(<span class="ruby-ivar">@order</span>).<span class="ruby-identifier">deliver</span>
  110. <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>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span>
  111. <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">&#39;.thanks&#39;</span>) }
  112. <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">:created</span>,
  113. <span class="ruby-identifier">location</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@order</span> }
  114. <span class="ruby-keyword">else</span>
  115. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:new</span> }
  116. <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">@order</span>.<span class="ruby-identifier">errors</span>,
  117. <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:unprocessable_entity</span> }
  118. <span class="ruby-keyword">end</span>
  119. <span class="ruby-keyword">end</span>
  120. <span class="ruby-keyword">end</span></pre>
  121. </div>
  122. </div>
  123. </div>
  124. <div id="method-i-destroy" class="method-detail ">
  125. <div class="method-heading">
  126. <span class="method-name">destroy</span><span
  127. class="method-args">()</span>
  128. <span class="method-click-advice">click to toggle source</span>
  129. </div>
  130. <div class="method-description">
  131. <p>DELETE /orders/1 DELETE /orders/1.json</p>
  132. <div class="method-source-code" id="destroy-source">
  133. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 83</span>
  134. <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
  135. <span class="ruby-ivar">@order</span>.<span class="ruby-identifier">destroy</span>
  136. <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>
  137. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">orders_url</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;Order was successfully destroyed.&#39;</span> }
  138. <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> }
  139. <span class="ruby-keyword">end</span>
  140. <span class="ruby-keyword">end</span></pre>
  141. </div>
  142. </div>
  143. </div>
  144. <div id="method-i-edit" class="method-detail ">
  145. <div class="method-heading">
  146. <span class="method-name">edit</span><span
  147. class="method-args">()</span>
  148. <span class="method-click-advice">click to toggle source</span>
  149. </div>
  150. <div class="method-description">
  151. <p>GET /orders/1/edit</p>
  152. <div class="method-source-code" id="edit-source">
  153. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 35</span>
  154. <span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span>
  155. <span class="ruby-keyword">end</span></pre>
  156. </div>
  157. </div>
  158. </div>
  159. <div id="method-i-index" class="method-detail ">
  160. <div class="method-heading">
  161. <span class="method-name">index</span><span
  162. class="method-args">()</span>
  163. <span class="method-click-advice">click to toggle source</span>
  164. </div>
  165. <div class="method-description">
  166. <pre>GET /orders</pre>
  167. <p>END:current_cart</p>
  168. <pre>GET /orders.json</pre>
  169. <div class="method-source-code" id="index-source">
  170. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 13</span>
  171. <span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span>
  172. <span class="ruby-ivar">@orders</span> = <span class="ruby-constant">Order</span>.<span class="ruby-identifier">all</span>
  173. <span class="ruby-keyword">end</span></pre>
  174. </div>
  175. </div>
  176. </div>
  177. <div id="method-i-new" class="method-detail ">
  178. <div class="method-heading">
  179. <span class="method-name">new</span><span
  180. class="method-args">()</span>
  181. <span class="method-click-advice">click to toggle source</span>
  182. </div>
  183. <div class="method-description">
  184. <pre>GET /orders/new</pre>
  185. <p>START:checkout</p>
  186. <div class="method-source-code" id="new-source">
  187. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 24</span>
  188. <span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span>
  189. <span class="ruby-keyword">if</span> <span class="ruby-ivar">@cart</span>.<span class="ruby-identifier">line_items</span>.<span class="ruby-identifier">empty?</span>
  190. <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">store_url</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;Your cart is empty&quot;</span>
  191. <span class="ruby-keyword">return</span>
  192. <span class="ruby-keyword">end</span>
  193. <span class="ruby-ivar">@order</span> = <span class="ruby-constant">Order</span>.<span class="ruby-identifier">new</span>
  194. <span class="ruby-keyword">end</span></pre>
  195. </div>
  196. </div>
  197. </div>
  198. <div id="method-i-show" class="method-detail ">
  199. <div class="method-heading">
  200. <span class="method-name">show</span><span
  201. class="method-args">()</span>
  202. <span class="method-click-advice">click to toggle source</span>
  203. </div>
  204. <div class="method-description">
  205. <p>GET /orders/1 GET /orders/1.json</p>
  206. <div class="method-source-code" id="show-source">
  207. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 19</span>
  208. <span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span>
  209. <span class="ruby-keyword">end</span></pre>
  210. </div>
  211. </div>
  212. </div>
  213. <div id="method-i-update" class="method-detail ">
  214. <div class="method-heading">
  215. <span class="method-name">update</span><span
  216. class="method-args">()</span>
  217. <span class="method-click-advice">click to toggle source</span>
  218. </div>
  219. <div class="method-description">
  220. <p>PATCH/PUT /orders/1 PATCH/PUT /orders/1.json</p>
  221. <div class="method-source-code" id="update-source">
  222. <pre><span class="ruby-comment"># File app/controllers/orders_controller.rb, line 69</span>
  223. <span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>
  224. <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>
  225. <span class="ruby-keyword">if</span> <span class="ruby-ivar">@order</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">order_params</span>)
  226. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-ivar">@order</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;Order was successfully updated.&#39;</span> }
  227. <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">@order</span> }
  228. <span class="ruby-keyword">else</span>
  229. <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-value">:edit</span> }
  230. <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">@order</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> }
  231. <span class="ruby-keyword">end</span>
  232. <span class="ruby-keyword">end</span>
  233. <span class="ruby-keyword">end</span></pre>
  234. </div>
  235. </div>
  236. </div>
  237. </section>
  238. </section>
  239. </main>
  240. <footer id="validator-badges" role="contentinfo">
  241. <p><a href="http://validator.w3.org/check/referer">Validate</a>
  242. <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
  243. <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
  244. </footer>