Commit | Line | Data |
fbbb9084 |
1 | =head1 NAME |
d442cc9f |
2 | |
3ab6187c |
3 | Catalyst::Manual::Tutorial::04_BasicCRUD - Catalyst Tutorial - Chapter 4: Basic CRUD |
d442cc9f |
4 | |
5 | |
6 | =head1 OVERVIEW |
7 | |
4b4d3884 |
8 | This is B<Chapter 4 of 10> for the Catalyst tutorial. |
d442cc9f |
9 | |
10 | L<Tutorial Overview|Catalyst::Manual::Tutorial> |
11 | |
12 | =over 4 |
13 | |
14 | =item 1 |
15 | |
3ab6187c |
16 | L<Introduction|Catalyst::Manual::Tutorial::01_Intro> |
d442cc9f |
17 | |
18 | =item 2 |
19 | |
3ab6187c |
20 | L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics> |
d442cc9f |
21 | |
22 | =item 3 |
23 | |
3ab6187c |
24 | L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics> |
d442cc9f |
25 | |
26 | =item 4 |
27 | |
3ab6187c |
28 | B<04_Basic CRUD> |
d442cc9f |
29 | |
30 | =item 5 |
31 | |
3ab6187c |
32 | L<Authentication|Catalyst::Manual::Tutorial::05_Authentication> |
d442cc9f |
33 | |
34 | =item 6 |
35 | |
3ab6187c |
36 | L<Authorization|Catalyst::Manual::Tutorial::06_Authorization> |
d442cc9f |
37 | |
38 | =item 7 |
39 | |
3ab6187c |
40 | L<Debugging|Catalyst::Manual::Tutorial::07_Debugging> |
d442cc9f |
41 | |
42 | =item 8 |
43 | |
3ab6187c |
44 | L<Testing|Catalyst::Manual::Tutorial::08_Testing> |
d442cc9f |
45 | |
46 | =item 9 |
47 | |
3ab6187c |
48 | L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD> |
3533daff |
49 | |
50 | =item 10 |
51 | |
3ab6187c |
52 | L<Appendices|Catalyst::Manual::Tutorial::10_Appendices> |
d442cc9f |
53 | |
54 | =back |
55 | |
56 | |
d442cc9f |
57 | =head1 DESCRIPTION |
58 | |
ee53cc71 |
59 | This chapter of the tutorial builds on the fairly primitive application |
22fe0f18 |
60 | created in |
61 | L<Chapter 3|Catalyst::Manual::Tutorial::03_MoreCatalystBasics> to add |
62 | basic support for Create, Read, Update, and Delete (CRUD) of C<Book> |
63 | objects. Note that the 'list' function in Chapter 3 already implements |
64 | the Read portion of CRUD (although Read normally refers to reading a |
65 | single object; you could implement full Read functionality using the |
66 | techniques introduced below). This section will focus on the Create and |
67 | Delete aspects of CRUD. More advanced capabilities, including full |
68 | Update functionality, will be addressed in |
69 | L<Chapter 9|Catalyst::Manual::Tutorial::09_AdvancedCRUD>. |
ee53cc71 |
70 | |
71 | Although this chapter of the tutorial will show you how to build CRUD |
72 | functionality yourself, another option is to use a "CRUD builder" type |
73 | of tool to automate the process. You get less control, but it can be |
74 | quick and easy. For example, see L<Catalyst::Plugin::AutoCRUD>, |
75 | L<CatalystX::CRUD>, and L<CatalystX::CRUD::YUI>. |
1390ef0e |
76 | |
72609296 |
77 | You can check out the source code for this example from the Catalyst |
78 | Subversion repository as per the instructions in |
2217b252 |
79 | L<Catalyst::Manual::Tutorial::01_Intro>. |
d442cc9f |
80 | |
3533daff |
81 | |
d442cc9f |
82 | =head1 FORMLESS SUBMISSION |
83 | |
ee53cc71 |
84 | Our initial attempt at object creation will utilize the "URL arguments" |
22fe0f18 |
85 | feature of Catalyst (we will employ the more common form-based |
ee53cc71 |
86 | submission in the sections that follow). |
d442cc9f |
87 | |
88 | |
89 | =head2 Include a Create Action in the Books Controller |
90 | |
91 | Edit C<lib/MyApp/Controller/Books.pm> and enter the following method: |
92 | |
93 | =head2 url_create |
fce83e5f |
94 | |
d442cc9f |
95 | Create a book with the supplied title, rating, and author |
fce83e5f |
96 | |
d442cc9f |
97 | =cut |
fce83e5f |
98 | |
f2bbfc36 |
99 | sub url_create :Local { |
55490817 |
100 | # In addition to self & context, get the title, rating, & |
101 | # author_id args from the URL. Note that Catalyst automatically |
102 | # puts extra information after the "/<controller_name>/<action_name/" |
fce83e5f |
103 | # into @_. The args are separated by the '/' char on the URL. |
d442cc9f |
104 | my ($self, $c, $title, $rating, $author_id) = @_; |
fce83e5f |
105 | |
55490817 |
106 | # Call create() on the book model object. Pass the table |
d442cc9f |
107 | # columns/field values we want to set as hash values |
3b1fa91b |
108 | my $book = $c->model('DB::Book')->create({ |
d442cc9f |
109 | title => $title, |
110 | rating => $rating |
111 | }); |
fce83e5f |
112 | |
55490817 |
113 | # Add a record to the join table for this book, mapping to |
d442cc9f |
114 | # appropriate author |
fce83e5f |
115 | $book->add_to_book_authors({author_id => $author_id}); |
d442cc9f |
116 | # Note: Above is a shortcut for this: |
fce83e5f |
117 | # $book->create_related('book_authors', {author_id => $author_id}); |
118 | |
0ed3df53 |
119 | # Assign the Book object to the stash for display and set template |
120 | $c->stash(book => $book, |
121 | template => 'books/create_done.tt2'); |
22fe0f18 |
122 | |
123 | # Disable caching for this page |
124 | $c->response->header('Cache-Control' => 'no-cache'); |
d442cc9f |
125 | } |
126 | |
127 | Notice that Catalyst takes "extra slash-separated information" from the |
22fe0f18 |
128 | URL and passes it as arguments in C<@_> (as long as the number of |
129 | arguments is not "fixed" using an attribute like C<:Args(0)>). The |
130 | C<url_create> action then uses a simple call to the DBIC C<create> |
131 | method to add the requested information to the database (with a separate |
132 | call to C<add_to_book_authors> to update the join table). As do |
133 | virtually all controller methods (at least the ones that directly handle |
134 | user input), it then sets the template that should handle this request. |
135 | |
136 | Also note that we are explicitly setting a C<no-cache> "Cache-Control" |
137 | header to force browsers using the page to get a fresh copy every time. |
138 | You could even move this to a C<auto> method in |
139 | C<lib/MyApp/Controller/Root.pm> and it would automatically get applied |
140 | to every page in the whole application via a single line of code |
141 | (remember from Chapter 3, that every C<auto> method gets run in the |
142 | Controller hierarchy). |
d442cc9f |
143 | |
144 | |
8a472b34 |
145 | =head2 Include a Template for the 'url_create' Action: |
d442cc9f |
146 | |
147 | Edit C<root/src/books/create_done.tt2> and then enter: |
148 | |
149 | [% # Use the TT Dumper plugin to Data::Dumper variables to the browser -%] |
150 | [% # Not a good idea for production use, though. :-) 'Indent=1' is -%] |
151 | [% # optional, but prevents "massive indenting" of deeply nested objects -%] |
152 | [% USE Dumper(Indent=1) -%] |
fce83e5f |
153 | |
d442cc9f |
154 | [% # Set the page title. META can 'go back' and set values in templates -%] |
22fe0f18 |
155 | [% # that have been processed 'before' this template (here it's updating -%] |
156 | [% # the title in the root/src/wrapper.tt2 wrapper template). Note that -%] |
157 | [% # META only works on simple/static strings (i.e. there is no variable -%] |
158 | [% # interpolation -- if you need dynamic/interpolated content in your -%] |
159 | [% # title, set "$c->stash(title => $something)" in the controller). -%] |
d442cc9f |
160 | [% META title = 'Book Created' %] |
fce83e5f |
161 | |
162 | [% # Output information about the record that was added. First title. -%] |
d442cc9f |
163 | <p>Added book '[% book.title %]' |
fce83e5f |
164 | |
22fe0f18 |
165 | [% # Then, output the last name of the first author -%] |
fce83e5f |
166 | by '[% book.authors.first.last_name %]' |
167 | |
22fe0f18 |
168 | [% # Then, output the rating for the book that was added -%] |
d442cc9f |
169 | with a rating of [% book.rating %].</p> |
fce83e5f |
170 | |
22fe0f18 |
171 | [% # Provide a link back to the list page. 'c.uri_for' builds -%] |
172 | [% # a full URI; e.g., 'http://localhost:3000/books/list' -%] |
8a7c5151 |
173 | <p><a href="[% c.uri_for('/books/list') %]">Return to list</a></p> |
fce83e5f |
174 | |
d442cc9f |
175 | [% # Try out the TT Dumper (for development only!) -%] |
176 | <pre> |
177 | Dump of the 'book' variable: |
178 | [% Dumper.dump(book) %] |
179 | </pre> |
180 | |
ee53cc71 |
181 | The TT C<USE> directive allows access to a variety of plugin modules (TT |
182 | plugins, that is, not Catalyst plugins) to add extra functionality to |
183 | the base TT capabilities. Here, the plugin allows L<Data::Dumper> |
184 | "pretty printing" of objects and variables. Other than that, the rest |
185 | of the code should be familiar from the examples in Chapter 3. |
d442cc9f |
186 | |
d442cc9f |
187 | |
8a472b34 |
188 | =head2 Try the 'url_create' Feature |
d442cc9f |
189 | |
f2bbfc36 |
190 | Make sure the development server is running with the "-r" restart |
191 | option: |
d442cc9f |
192 | |
f2bbfc36 |
193 | $ DBIC_TRACE=1 script/myapp_server.pl -r |
d442cc9f |
194 | |
195 | Note that new path for C</books/url_create> appears in the startup debug |
196 | output. |
197 | |
d442cc9f |
198 | Next, use your browser to enter the following URL: |
199 | |
200 | http://localhost:3000/books/url_create/TCPIP_Illustrated_Vol-2/5/4 |
201 | |
55490817 |
202 | Your browser should display "Added book 'TCPIP_Illustrated_Vol-2' by |
203 | 'Stevens' with a rating of 5." along with a dump of the new book model |
204 | object as it was returned by DBIC. You should also see the following |
ee53cc71 |
205 | DBIC debug messages displayed in the development server log messages if |
206 | you have DBIC_TRACE set: |
d442cc9f |
207 | |
3b1fa91b |
208 | INSERT INTO book (rating, title) VALUES (?, ?): `5', `TCPIP_Illustrated_Vol-2' |
209 | INSERT INTO book_author (author_id, book_id) VALUES (?, ?): `4', `6' |
d442cc9f |
210 | |
211 | The C<INSERT> statements are obviously adding the book and linking it to |
ee53cc71 |
212 | the existing record for Richard Stevens. The C<SELECT> statement |
213 | results from DBIC automatically fetching the book for the |
214 | C<Dumper.dump(book)>. |
d442cc9f |
215 | |
ee53cc71 |
216 | If you then click the "Return to list" link, you should find that there |
217 | are now six books shown (if necessary, Shift+Reload or Ctrl+Reload your |
218 | browser at the C</books/list> page). You should now see the six DBIC |
219 | debug messages similar to the following (where N=1-6): |
3b1fa91b |
220 | |
a467a714 |
221 | SELECT author.id, author.first_name, author.last_name |
222 | FROM book_author me JOIN author author |
fce83e5f |
223 | ON author.id = me.author_id WHERE ( me.book_id = ? ): 'N' |
224 | |
d442cc9f |
225 | |
89d3dae9 |
226 | =head1 CONVERT TO A CHAINED ACTION |
227 | |
55490817 |
228 | Although the example above uses the same C<Local> action type for the |
4b4d3884 |
229 | method that we saw in the previous chapter of the tutorial, there is an |
ee53cc71 |
230 | alternate approach that allows us to be more specific while also paving |
231 | the way for more advanced capabilities. Change the method declaration |
232 | for C<url_create> in C<lib/MyApp/Controller/Books.pm> you entered above |
233 | to match the following: |
89d3dae9 |
234 | |
235 | sub url_create :Chained('/') :PathPart('books/url_create') :Args(3) { |
fce83e5f |
236 | # In addition to self & context, get the title, rating, & |
237 | # author_id args from the URL. Note that Catalyst automatically |
238 | # puts the first 3 arguments worth of extra information after the |
239 | # "/<controller_name>/<action_name/" into @_ because we specified |
240 | # "Args(3)". The args are separated by the '/' char on the URL. |
241 | my ($self, $c, $title, $rating, $author_id) = @_; |
242 | |
243 | ... |
89d3dae9 |
244 | |
55490817 |
245 | This converts the method to take advantage of the Chained |
ee53cc71 |
246 | action/dispatch type. Chaining lets you have a single URL automatically |
247 | dispatch to several controller methods, each of which can have precise |
248 | control over the number of arguments that it will receive. A chain can |
249 | essentially be thought of having three parts -- a beginning, a middle, |
250 | and an end. The bullets below summarize the key points behind each of |
251 | these parts of a chain: |
89d3dae9 |
252 | |
253 | |
254 | =over 4 |
255 | |
256 | |
257 | =item * |
258 | |
259 | Beginning |
260 | |
261 | =over 4 |
262 | |
263 | =item * |
264 | |
265 | B<Use "C<:Chained('/')>" to start a chain> |
266 | |
267 | =item * |
268 | |
269 | Get arguments through C<CaptureArgs()> |
270 | |
271 | =item * |
272 | |
273 | Specify the path to match with C<PathPart()> |
274 | |
275 | =back |
276 | |
277 | |
278 | =item * |
279 | |
280 | Middle |
281 | |
282 | =over 4 |
283 | |
284 | =item * |
d442cc9f |
285 | |
89d3dae9 |
286 | Link to previous part of the chain with C<:Chained('_name_')> |
287 | |
288 | =item * |
289 | |
290 | Get arguments through C<CaptureArgs()> |
291 | |
292 | =item * |
293 | |
294 | Specify the path to match with C<PathPart()> |
295 | |
296 | =back |
297 | |
298 | |
299 | =item * |
300 | |
301 | End |
302 | |
303 | =over 4 |
304 | |
305 | =item * |
306 | |
307 | Link to previous part of the chain with C<:Chained('_name_')> |
308 | |
309 | =item * |
310 | |
311 | B<Do NOT get arguments through "C<CaptureArgs()>," use "C<Args()>" instead to end a chain> |
312 | |
313 | =item * |
314 | |
315 | Specify the path to match with C<PathPart()> |
316 | |
317 | =back |
318 | |
319 | |
320 | =back |
321 | |
72609296 |
322 | In our C<url_create> method above, we have combined all three parts into |
323 | a single method: C<:Chained('/')> to start the chain, |
324 | C<:PathPart('books/url_create')> to specify the base URL to match, and |
325 | C<:Args(3)> to capture exactly three arguments and to end the chain. |
89d3dae9 |
326 | |
55490817 |
327 | As we will see shortly, a chain can consist of as many "links" as you |
ee53cc71 |
328 | wish, with each part capturing some arguments and doing some work along |
329 | the way. We will continue to use the Chained action type in this |
4b4d3884 |
330 | chapter of the tutorial and explore slightly more advanced capabilities |
ee53cc71 |
331 | with the base method and delete feature below. But Chained dispatch is |
332 | capable of far more. For additional information, see |
55490817 |
333 | L<Catalyst::Manual::Intro/Action types>, |
ee53cc71 |
334 | L<Catalyst::DispatchType::Chained>, and the 2006 Advent calendar entry |
335 | on the subject: L<http://www.catalystframework.org/calendar/2006/10>. |
89d3dae9 |
336 | |
337 | |
338 | =head2 Try the Chained Action |
339 | |
55490817 |
340 | If you look back at the development server startup logs from your |
ee53cc71 |
341 | initial version of the C<url_create> method (the one using the C<:Local> |
342 | attribute), you will notice that it produced output similar to the |
343 | following: |
89d3dae9 |
344 | |
fbbb9084 |
345 | [debug] Loaded Path actions: |
346 | .-------------------------------------+--------------------------------------. |
347 | | Path | Private | |
348 | +-------------------------------------+--------------------------------------+ |
349 | | / | /default | |
350 | | / | /index | |
351 | | /books | /books/index | |
352 | | /books/list | /books/list | |
353 | | /books/url_create | /books/url_create | |
354 | '-------------------------------------+--------------------------------------' |
89d3dae9 |
355 | |
22fe0f18 |
356 | When the development server restarts after our conversion to Chained |
357 | dispatch, the debug output should change to something along the lines of |
358 | the following: |
89d3dae9 |
359 | |
fbbb9084 |
360 | [debug] Loaded Path actions: |
361 | .-------------------------------------+--------------------------------------. |
362 | | Path | Private | |
363 | +-------------------------------------+--------------------------------------+ |
364 | | / | /default | |
365 | | / | /index | |
366 | | /books | /books/index | |
367 | | /books/list | /books/list | |
368 | '-------------------------------------+--------------------------------------' |
fce83e5f |
369 | |
fbbb9084 |
370 | [debug] Loaded Chained actions: |
371 | .-------------------------------------+--------------------------------------. |
372 | | Path Spec | Private | |
373 | +-------------------------------------+--------------------------------------+ |
374 | | /books/url_create/*/*/* | /books/url_create | |
375 | '-------------------------------------+--------------------------------------' |
89d3dae9 |
376 | |
ee53cc71 |
377 | C<url_create> has disappeared from the "Loaded Path actions" section but |
378 | it now shows up under the newly created "Loaded Chained actions" |
72609296 |
379 | section. And the "/*/*/*" portion clearly shows our requirement for |
fbbb9084 |
380 | three arguments. |
89d3dae9 |
381 | |
55490817 |
382 | As with our non-chained version of C<url_create>, use your browser to |
89d3dae9 |
383 | enter the following URL: |
384 | |
fbbb9084 |
385 | http://localhost:3000/books/url_create/TCPIP_Illustrated_Vol-2/5/4 |
89d3dae9 |
386 | |
55490817 |
387 | You should see the same "Added book 'TCPIP_Illustrated_Vol-2' by |
388 | 'Stevens' with a rating of 5." along with a dump of the new book model |
72609296 |
389 | object. Click the "Return to list" link, and you should find that there |
390 | are now seven books shown (two copies of I<TCPIP_Illustrated_Vol-2>). |
89d3dae9 |
391 | |
392 | |
8a472b34 |
393 | =head2 Refactor to Use a 'base' Method to Start the Chains |
89d3dae9 |
394 | |
ee53cc71 |
395 | Let's make a quick update to our initial Chained action to show a little |
396 | more of the power of chaining. First, open |
89d3dae9 |
397 | C<lib/MyApp/Controller/Books.pm> in your editor and add the following |
398 | method: |
399 | |
fbbb9084 |
400 | =head2 base |
fce83e5f |
401 | |
fbbb9084 |
402 | Can place common logic to start chained dispatch here |
fce83e5f |
403 | |
fbbb9084 |
404 | =cut |
fce83e5f |
405 | |
fbbb9084 |
406 | sub base :Chained('/') :PathPart('books') :CaptureArgs(0) { |
407 | my ($self, $c) = @_; |
fce83e5f |
408 | |
1cde0fd6 |
409 | # Store the ResultSet in stash so it's available for other methods |
0ed3df53 |
410 | $c->stash(resultset => $c->model('DB::Book')); |
fce83e5f |
411 | |
fbbb9084 |
412 | # Print a message to the debug log |
413 | $c->log->debug('*** INSIDE BASE METHOD ***'); |
414 | } |
415 | |
55490817 |
416 | Here we print a log message and store the DBIC ResultSet in |
417 | C<$c-E<gt>stash-E<gt>{resultset}> so that it's automatically available |
418 | for other actions that chain off C<base>. If your controller always |
72609296 |
419 | needs a book ID as its first argument, you could have the base method |
55490817 |
420 | capture that argument (with C<:CaptureArgs(1)>) and use it to pull the |
ee53cc71 |
421 | book object with C<-E<gt>find($id)> and leave it in the stash for later |
422 | parts of your chains to then act upon. Because we have several actions |
423 | that don't need to retrieve a book (such as the C<url_create> we are |
424 | working with now), we will instead add that functionality to a common |
425 | C<object> action shortly. |
994b66ad |
426 | |
55490817 |
427 | As for C<url_create>, let's modify it to first dispatch to C<base>. |
428 | Open up C<lib/MyApp/Controller/Books.pm> and edit the declaration for |
994b66ad |
429 | C<url_create> to match the following: |
89d3dae9 |
430 | |
431 | sub url_create :Chained('base') :PathPart('url_create') :Args(3) { |
432 | |
ee53cc71 |
433 | Once you save C<lib/MyApp/Controller/Books.pm>, notice that the |
434 | development server will restart and our "Loaded Chained actions" section |
f2bbfc36 |
435 | will changed slightly: |
55490817 |
436 | |
fbbb9084 |
437 | [debug] Loaded Chained actions: |
438 | .-------------------------------------+--------------------------------------. |
439 | | Path Spec | Private | |
440 | +-------------------------------------+--------------------------------------+ |
441 | | /books/url_create/*/*/* | /books/base (0) | |
442 | | | => /books/url_create | |
443 | '-------------------------------------+--------------------------------------' |
89d3dae9 |
444 | |
ee53cc71 |
445 | The "Path Spec" is the same, but now it maps to two Private actions as |
446 | we would expect. The C<base> method is being triggered by the C</books> |
447 | part of the URL. However, the processing then continues to the |
448 | C<url_create> method because this method "chained" off C<base> and |
449 | specified C<:PathPart('url_create')> (note that we could have omitted |
450 | the "PathPart" here because it matches the name of the method, but we |
444d6b27 |
451 | will include it to make the logic as explicit as possible). |
89d3dae9 |
452 | |
453 | Once again, enter the following URL into your browser: |
454 | |
fbbb9084 |
455 | http://localhost:3000/books/url_create/TCPIP_Illustrated_Vol-2/5/4 |
89d3dae9 |
456 | |
ee53cc71 |
457 | The same "Added book 'TCPIP_Illustrated_Vol-2' by 'Stevens' with a |
458 | rating of 5." message and a dump of the new book object should appear. |
459 | Also notice the extra "INSIDE BASE METHOD" debug message in the |
460 | development server output from the C<base> method. Click the "Return to |
461 | list" link, and you should find that there are now eight books shown. |
462 | (You may have a larger number of books if you repeated any of the |
463 | "create" actions more than once. Don't worry about it as long as the |
464 | number of books is appropriate for the number of times you added new |
465 | books... there should be the original five books added via |
466 | C<myapp01.sql> plus one additional book for each time you ran one of the |
467 | url_create variations above.) |
d442cc9f |
468 | |
469 | |
470 | =head1 MANUALLY BUILDING A CREATE FORM |
471 | |
472 | Although the C<url_create> action in the previous step does begin to |
473 | reveal the power and flexibility of both Catalyst and DBIC, it's |
474 | obviously not a very realistic example of how users should be expected |
22fe0f18 |
475 | to enter data. This section begins to address that concern (but just |
476 | barely, see L<Chapter 9|Catalyst::Manual::Tutorial::09_AdvancedCRUD> |
477 | for better options for handling web-based forms). |
d442cc9f |
478 | |
479 | |
480 | =head2 Add Method to Display The Form |
481 | |
482 | Edit C<lib/MyApp/Controller/Books.pm> and add the following method: |
483 | |
484 | =head2 form_create |
fce83e5f |
485 | |
d442cc9f |
486 | Display form to collect information for book to create |
fce83e5f |
487 | |
d442cc9f |
488 | =cut |
fce83e5f |
489 | |
89d3dae9 |
490 | sub form_create :Chained('base') :PathPart('form_create') :Args(0) { |
d442cc9f |
491 | my ($self, $c) = @_; |
fce83e5f |
492 | |
d442cc9f |
493 | # Set the TT template to use |
0ed3df53 |
494 | $c->stash(template => 'books/form_create.tt2'); |
d442cc9f |
495 | } |
496 | |
72609296 |
497 | This action simply invokes a view containing a form to create a book. |
d442cc9f |
498 | |
1390ef0e |
499 | |
d442cc9f |
500 | =head2 Add a Template for the Form |
501 | |
502 | Open C<root/src/books/form_create.tt2> in your editor and enter: |
503 | |
504 | [% META title = 'Manual Form Book Create' -%] |
444d6b27 |
505 | |
8a7c5151 |
506 | <form method="post" action="[% c.uri_for('form_create_do') %]"> |
d442cc9f |
507 | <table> |
508 | <tr><td>Title:</td><td><input type="text" name="title"></td></tr> |
509 | <tr><td>Rating:</td><td><input type="text" name="rating"></td></tr> |
510 | <tr><td>Author ID:</td><td><input type="text" name="author_id"></td></tr> |
511 | </table> |
512 | <input type="submit" name="Submit" value="Submit"> |
513 | </form> |
514 | |
515 | Note that we have specified the target of the form data as |
516 | C<form_create_do>, the method created in the section that follows. |
517 | |
1390ef0e |
518 | |
d442cc9f |
519 | =head2 Add a Method to Process Form Values and Update Database |
520 | |
521 | Edit C<lib/MyApp/Controller/Books.pm> and add the following method to |
522 | save the form information to the database: |
523 | |
524 | =head2 form_create_do |
fce83e5f |
525 | |
d442cc9f |
526 | Take information from form and add to database |
fce83e5f |
527 | |
d442cc9f |
528 | =cut |
fce83e5f |
529 | |
89d3dae9 |
530 | sub form_create_do :Chained('base') :PathPart('form_create_do') :Args(0) { |
d442cc9f |
531 | my ($self, $c) = @_; |
fce83e5f |
532 | |
d442cc9f |
533 | # Retrieve the values from the form |
534 | my $title = $c->request->params->{title} || 'N/A'; |
535 | my $rating = $c->request->params->{rating} || 'N/A'; |
536 | my $author_id = $c->request->params->{author_id} || '1'; |
fce83e5f |
537 | |
d442cc9f |
538 | # Create the book |
3b1fa91b |
539 | my $book = $c->model('DB::Book')->create({ |
d442cc9f |
540 | title => $title, |
541 | rating => $rating, |
542 | }); |
543 | # Handle relationship with author |
fce83e5f |
544 | $book->add_to_book_authors({author_id => $author_id}); |
545 | # Note: Above is a shortcut for this: |
546 | # $book->create_related('book_authors', {author_id => $author_id}); |
547 | |
0ed3df53 |
548 | # Store new model object in stash and set template |
549 | $c->stash(book => $book, |
550 | template => 'books/create_done.tt2'); |
d442cc9f |
551 | } |
552 | |
553 | |
554 | =head2 Test Out The Form |
555 | |
ee53cc71 |
556 | Notice that the server startup log reflects the two new chained methods |
557 | that we added: |
89d3dae9 |
558 | |
fbbb9084 |
559 | [debug] Loaded Chained actions: |
560 | .-------------------------------------+--------------------------------------. |
561 | | Path Spec | Private | |
562 | +-------------------------------------+--------------------------------------+ |
563 | | /books/form_create | /books/base (0) | |
564 | | | => /books/form_create | |
565 | | /books/form_create_do | /books/base (0) | |
566 | | | => /books/form_create_do | |
567 | | /books/url_create/*/*/* | /books/base (0) | |
568 | | | => /books/url_create | |
569 | '-------------------------------------+--------------------------------------' |
89d3dae9 |
570 | |
d442cc9f |
571 | Point your browser to L<http://localhost:3000/books/form_create> and |
572 | enter "TCP/IP Illustrated, Vol 3" for the title, a rating of 5, and an |
1390ef0e |
573 | author ID of 4. You should then see the output of the same |
d442cc9f |
574 | C<create_done.tt2> template seen in earlier examples. Finally, click |
575 | "Return to list" to view the full list of books. |
576 | |
577 | B<Note:> Having the user enter the primary key ID for the author is |
fce83e5f |
578 | obviously crude; we will address this concern with a drop-down list and |
22fe0f18 |
579 | add validation to our forms in |
580 | L<Chapter 9|Catalyst::Manual::Tutorial::09_AdvancedCRUD>. |
d442cc9f |
581 | |
582 | |
583 | =head1 A SIMPLE DELETE FEATURE |
584 | |
72609296 |
585 | Turning our attention to the Delete portion of CRUD, this section |
d442cc9f |
586 | illustrates some basic techniques that can be used to remove information |
587 | from the database. |
588 | |
589 | |
590 | =head2 Include a Delete Link in the List |
591 | |
ee53cc71 |
592 | Edit C<root/src/books/list.tt2> and update it to match the following |
593 | (two sections have changed: 1) the additional '<th>Links</th>' table |
22fe0f18 |
594 | header, and 2) the five lines for the Delete link near the bottom): |
d442cc9f |
595 | |
22fe0f18 |
596 | [% # This is a TT comment. -%] |
597 | |
598 | [%- # Provide a title -%] |
d442cc9f |
599 | [% META title = 'Book List' -%] |
22fe0f18 |
600 | |
601 | [% # Note That the '-' at the beginning or end of TT code -%] |
602 | [% # "chomps" the whitespace/newline at that end of the -%] |
603 | [% # output (use View Source in browser to see the effect) -%] |
604 | |
605 | [% # Some basic HTML with a loop to display books -%] |
d442cc9f |
606 | <table> |
607 | <tr><th>Title</th><th>Rating</th><th>Author(s)</th><th>Links</th></tr> |
608 | [% # Display each book in a table row %] |
609 | [% FOREACH book IN books -%] |
610 | <tr> |
611 | <td>[% book.title %]</td> |
612 | <td>[% book.rating %]</td> |
613 | <td> |
22fe0f18 |
614 | [% # NOTE: See Chapter 4 for a better way to do this! -%] |
d442cc9f |
615 | [% # First initialize a TT variable to hold a list. Then use a TT FOREACH -%] |
616 | [% # loop in 'side effect notation' to load just the last names of the -%] |
55490817 |
617 | [% # authors into the list. Note that the 'push' TT vmethod doesn't return -%] |
d442cc9f |
618 | [% # a value, so nothing will be printed here. But, if you have something -%] |
22fe0f18 |
619 | [% # in TT that does return a value and you don't want it printed, you -%] |
6d97b973 |
620 | [% # 1) assign it to a bogus value, or -%] |
621 | [% # 2) use the CALL keyword to call it and discard the return value. -%] |
d442cc9f |
622 | [% tt_authors = [ ]; |
fce83e5f |
623 | tt_authors.push(author.last_name) FOREACH author = book.authors %] |
d442cc9f |
624 | [% # Now use a TT 'virtual method' to display the author count in parens -%] |
3b1fa91b |
625 | [% # Note the use of the TT filter "| html" to escape dangerous characters -%] |
626 | ([% tt_authors.size | html %]) |
d442cc9f |
627 | [% # Use another TT vmethod to join & print the names & comma separators -%] |
3b1fa91b |
628 | [% tt_authors.join(', ') | html %] |
d442cc9f |
629 | </td> |
630 | <td> |
631 | [% # Add a link to delete a book %] |
22fe0f18 |
632 | <a href="[% |
633 | c.uri_for(c.controller.action_for('delete'), [book.id]) %]">Delete</a> |
d442cc9f |
634 | </td> |
635 | </tr> |
636 | [% END -%] |
637 | </table> |
638 | |
55490817 |
639 | The additional code is obviously designed to add a new column to the |
72609296 |
640 | right side of the table with a C<Delete> "button" (for simplicity, links |
22fe0f18 |
641 | will be used instead of full HTML buttons; but, in practice, anything |
642 | that modifies data should be handled with a form sending a POST |
643 | request). |
fe01b24f |
644 | |
ee53cc71 |
645 | Also notice that we are using a more advanced form of C<uri_for> than we |
646 | have seen before. Here we use C<$c-E<gt>controller-E<gt>action_for> to |
647 | automatically generate a URI appropriate for that action based on the |
648 | method we want to link to while inserting the C<book.id> value into the |
649 | appropriate place. Now, if you ever change C<:PathPart('delete')> in |
22fe0f18 |
650 | your controller method to something like C<:PathPart('kill')>, then your |
651 | links will automatically update without any changes to your .tt2 |
652 | template file. As long as the name of your method does not change |
653 | (here, "delete"), then your links will still be correct. There are a |
654 | few shortcuts and options when using C<action_for()>: |
0416017e |
655 | |
656 | =over 4 |
657 | |
658 | =item * |
659 | |
ee53cc71 |
660 | If you are referring to a method in the current controller, you can use |
661 | C<$self-E<gt>action_for('_method_name_')>. |
0416017e |
662 | |
663 | =item * |
664 | |
ee53cc71 |
665 | If you are referring to a method in a different controller, you need to |
666 | include that controller's name as an argument to C<controller()>, as in |
0416017e |
667 | C<$c-E<gt>controller('_controller_name_')-E<gt>action_for('_method_name_')>. |
668 | |
669 | =back |
b2ad8bbd |
670 | |
55490817 |
671 | B<Note:> In practice you should B<never> use a GET request to delete a |
672 | record -- always use POST for actions that will modify data. We are |
c5d94181 |
673 | doing it here for illustrative and simplicity purposes only. |
d442cc9f |
674 | |
1390ef0e |
675 | |
994b66ad |
676 | =head2 Add a Common Method to Retrieve a Book for the Chain |
677 | |
ee53cc71 |
678 | As mentioned earlier, since we have a mixture of actions that operate on |
679 | a single book ID and others that do not, we should not have C<base> |
55490817 |
680 | capture the book ID, find the corresponding book in the database and |
681 | save it in the stash for later links in the chain. However, just |
ee53cc71 |
682 | because that logic does not belong in C<base> doesn't mean that we can't |
683 | create another location to centralize the book lookup code. In our |
684 | case, we will create a method called C<object> that will store the |
55490817 |
685 | specific book in the stash. Chains that always operate on a single |
686 | existing book can chain off this method, but methods such as |
ee53cc71 |
687 | C<url_create> that don't operate on an existing book can chain directly |
688 | off base. |
994b66ad |
689 | |
ee53cc71 |
690 | To add the C<object> method, edit C<lib/MyApp/Controller/Books.pm> and |
691 | add the following code: |
994b66ad |
692 | |
e075db0c |
693 | =head2 object |
fce83e5f |
694 | |
e075db0c |
695 | Fetch the specified book object based on the book ID and store |
696 | it in the stash |
fce83e5f |
697 | |
e075db0c |
698 | =cut |
fce83e5f |
699 | |
994b66ad |
700 | sub object :Chained('base') :PathPart('id') :CaptureArgs(1) { |
fbbb9084 |
701 | # $id = primary key of book to delete |
994b66ad |
702 | my ($self, $c, $id) = @_; |
fce83e5f |
703 | |
994b66ad |
704 | # Find the book object and store it in the stash |
705 | $c->stash(object => $c->stash->{resultset}->find($id)); |
fce83e5f |
706 | |
994b66ad |
707 | # Make sure the lookup was successful. You would probably |
708 | # want to do something like this in a real app: |
709 | # $c->detach('/error_404') if !$c->stash->{object}; |
710 | die "Book $id not found!" if !$c->stash->{object}; |
fce83e5f |
711 | |
712 | # Print a message to the debug log |
713 | $c->log->debug("*** INSIDE OBJECT METHOD for obj id=$id ***"); |
994b66ad |
714 | } |
715 | |
ee53cc71 |
716 | Now, any other method that chains off C<object> will automatically have |
717 | the appropriate book waiting for it in C<$c-E<gt>stash-E<gt>{object}>. |
994b66ad |
718 | |
994b66ad |
719 | |
d442cc9f |
720 | =head2 Add a Delete Action to the Controller |
721 | |
722 | Open C<lib/MyApp/Controller/Books.pm> in your editor and add the |
723 | following method: |
724 | |
1390ef0e |
725 | =head2 delete |
fce83e5f |
726 | |
d442cc9f |
727 | Delete a book |
fce83e5f |
728 | |
d442cc9f |
729 | =cut |
fce83e5f |
730 | |
994b66ad |
731 | sub delete :Chained('object') :PathPart('delete') :Args(0) { |
994b66ad |
732 | my ($self, $c) = @_; |
fce83e5f |
733 | |
994b66ad |
734 | # Use the book object saved by 'object' and delete it along |
3b1fa91b |
735 | # with related 'book_author' entries |
994b66ad |
736 | $c->stash->{object}->delete; |
fce83e5f |
737 | |
d442cc9f |
738 | # Set a status message to be displayed at the top of the view |
739 | $c->stash->{status_msg} = "Book deleted."; |
fce83e5f |
740 | |
d442cc9f |
741 | # Forward to the list action/method in this controller |
742 | $c->forward('list'); |
743 | } |
744 | |
55490817 |
745 | This method first deletes the book object saved by the C<object> method. |
ee53cc71 |
746 | However, it also removes the corresponding entry from the C<book_author> |
747 | table with a cascading delete. |
d442cc9f |
748 | |
749 | Then, rather than forwarding to a "delete done" page as we did with the |
750 | earlier create example, it simply sets the C<status_msg> to display a |
751 | notification to the user as the normal list view is rendered. |
752 | |
753 | The C<delete> action uses the context C<forward> method to return the |
754 | user to the book list. The C<detach> method could have also been used. |
755 | Whereas C<forward> I<returns> to the original action once it is |
756 | completed, C<detach> does I<not> return. Other than that, the two are |
757 | equivalent. |
758 | |
759 | |
760 | =head2 Try the Delete Feature |
761 | |
ee53cc71 |
762 | Once you save the Books controller, the server should automatically |
763 | restart. The C<delete> method should now appear in the "Loaded Chained |
764 | actions" section of the startup debug output: |
89d3dae9 |
765 | |
fbbb9084 |
766 | [debug] Loaded Chained actions: |
994b66ad |
767 | .-------------------------------------+--------------------------------------. |
768 | | Path Spec | Private | |
769 | +-------------------------------------+--------------------------------------+ |
770 | | /books/id/*/delete | /books/base (0) | |
771 | | | -> /books/object (1) | |
772 | | | => /books/delete | |
773 | | /books/form_create | /books/base (0) | |
774 | | | => /books/form_create | |
775 | | /books/form_create_do | /books/base (0) | |
776 | | | => /books/form_create_do | |
777 | | /books/url_create/*/*/* | /books/base (0) | |
778 | | | => /books/url_create | |
779 | '-------------------------------------+--------------------------------------' |
89d3dae9 |
780 | |
d442cc9f |
781 | Then point your browser to L<http://localhost:3000/books/list> and click |
55490817 |
782 | the "Delete" link next to the first "TCPIP_Illustrated_Vol-2". A green |
783 | "Book deleted" status message should display at the top of the page, |
994b66ad |
784 | along with a list of the eight remaining books. You will also see the |
785 | cascading delete operation via the DBIC_TRACE output: |
786 | |
3b1fa91b |
787 | SELECT me.id, me.title, me.rating FROM book me WHERE ( ( me.id = ? ) ): '6' |
788 | DELETE FROM book WHERE ( id = ? ): '6' |
789 | SELECT me.book_id, me.author_id FROM book_author me WHERE ( me.book_id = ? ): '6' |
790 | DELETE FROM book_author WHERE ( author_id = ? AND book_id = ? ): '4', '6' |
d442cc9f |
791 | |
792 | |
793 | =head2 Fixing a Dangerous URL |
794 | |
55490817 |
795 | Note the URL in your browser once you have performed the deletion in the |
d442cc9f |
796 | prior step -- it is still referencing the delete action: |
797 | |
acbd7bdd |
798 | http://localhost:3000/books/id/6/delete |
d442cc9f |
799 | |
55490817 |
800 | What if the user were to press reload with this URL still active? In |
ee53cc71 |
801 | this case the redundant delete is harmless (although it does generate an |
802 | exception screen, it doesn't perform any undesirable actions on the |
22fe0f18 |
803 | application or database), but in other cases this could clearly lead to |
804 | trouble. |
d442cc9f |
805 | |
806 | We can improve the logic by converting to a redirect. Unlike |
ee53cc71 |
807 | C<$c-E<gt>forward('list'))> or C<$c-E<gt>detach('list'))> that perform a |
808 | server-side alteration in the flow of processing, a redirect is a |
809 | client-side mechanism that causes the browser to issue an entirely new |
810 | request. As a result, the URL in the browser is updated to match the |
811 | destination of the redirection URL. |
d442cc9f |
812 | |
ee53cc71 |
813 | To convert the forward used in the previous section to a redirect, open |
814 | C<lib/MyApp/Controller/Books.pm> and edit the existing C<sub delete> |
815 | method to match: |
d442cc9f |
816 | |
994b66ad |
817 | =head2 delete |
fce83e5f |
818 | |
d442cc9f |
819 | Delete a book |
fce83e5f |
820 | |
d442cc9f |
821 | =cut |
fce83e5f |
822 | |
994b66ad |
823 | sub delete :Chained('object') :PathPart('delete') :Args(0) { |
fbbb9084 |
824 | my ($self, $c) = @_; |
fce83e5f |
825 | |
994b66ad |
826 | # Use the book object saved by 'object' and delete it along |
3b1fa91b |
827 | # with related 'book_author' entries |
994b66ad |
828 | $c->stash->{object}->delete; |
fce83e5f |
829 | |
d442cc9f |
830 | # Set a status message to be displayed at the top of the view |
831 | $c->stash->{status_msg} = "Book deleted."; |
fce83e5f |
832 | |
0416017e |
833 | # Redirect the user back to the list page. Note the use |
834 | # of $self->action_for as earlier in this section (BasicCRUD) |
fbbb9084 |
835 | $c->response->redirect($c->uri_for($self->action_for('list'))); |
d442cc9f |
836 | } |
837 | |
838 | |
839 | =head2 Try the Delete and Redirect Logic |
840 | |
ee53cc71 |
841 | Point your browser to L<http://localhost:3000/books/list> (don't just |
842 | hit "Refresh" in your browser since we left the URL in an invalid state |
843 | in the previous section!) and delete the first copy of the remaining two |
844 | "TCPIP_Illustrated_Vol-2" books. The URL in your browser should return |
845 | to the L<http://localhost:3000/books/list> URL, so that is an |
846 | improvement, but notice that I<no green "Book deleted" status message is |
847 | displayed>. Because the stash is reset on every request (and a redirect |
848 | involves a second request), the C<status_msg> is cleared before it can |
22fe0f18 |
849 | be displayed. |
d442cc9f |
850 | |
851 | |
8a472b34 |
852 | =head2 Using 'uri_for' to Pass Query Parameters |
d442cc9f |
853 | |
ee53cc71 |
854 | There are several ways to pass information across a redirect. One option |
22fe0f18 |
855 | is to use the C<flash> technique that we will see in |
856 | L<Chapter 5|Catalyst::Manual::Tutorial::05_Authentication> of this |
ee53cc71 |
857 | tutorial; however, here we will pass the information via query |
858 | parameters on the redirect itself. Open |
859 | C<lib/MyApp/Controller/Books.pm> and update the existing C<sub delete> |
89d3dae9 |
860 | method to match the following: |
d442cc9f |
861 | |
55490817 |
862 | =head2 delete |
fce83e5f |
863 | |
d442cc9f |
864 | Delete a book |
fce83e5f |
865 | |
d442cc9f |
866 | =cut |
fce83e5f |
867 | |
994b66ad |
868 | sub delete :Chained('object') :PathPart('delete') :Args(0) { |
fbbb9084 |
869 | my ($self, $c) = @_; |
fce83e5f |
870 | |
994b66ad |
871 | # Use the book object saved by 'object' and delete it along |
3b1fa91b |
872 | # with related 'book_author' entries |
994b66ad |
873 | $c->stash->{object}->delete; |
fce83e5f |
874 | |
d442cc9f |
875 | # Redirect the user back to the list page with status msg as an arg |
55490817 |
876 | $c->response->redirect($c->uri_for($self->action_for('list'), |
d442cc9f |
877 | {status_msg => "Book deleted."})); |
878 | } |
879 | |
880 | This modification simply leverages the ability of C<uri_for> to include |
55490817 |
881 | an arbitrary number of name/value pairs in a hash reference. Next, we |
882 | need to update C<root/src/wrapper.tt2> to handle C<status_msg> as a |
d442cc9f |
883 | query parameter: |
884 | |
1390ef0e |
885 | ... |
d442cc9f |
886 | <div id="content"> |
1390ef0e |
887 | [%# Status and error messages %] |
ee53cc71 |
888 | <span class="message">[% |
889 | status_msg || c.request.params.status_msg | html %]</span> |
1390ef0e |
890 | <span class="error">[% error_msg %]</span> |
891 | [%# This is where TT will stick all of your template's contents. -%] |
892 | [% content %] |
893 | </div><!-- end content --> |
894 | ... |
895 | |
ee53cc71 |
896 | Although the sample above only shows the C<content> div, leave the rest |
897 | of the file intact -- the only change we made to the C<wrapper.tt2> was |
22fe0f18 |
898 | to add "C<|| c.request.params.status_msg>" to the |
899 | C<E<lt>span class="message"E<gt>> line. |
d442cc9f |
900 | |
901 | |
902 | =head2 Try the Delete and Redirect With Query Param Logic |
903 | |
ee53cc71 |
904 | Point your browser to L<http://localhost:3000/books/list> (you should |
905 | now be able to safely hit "refresh" in your browser). Then delete the |
906 | remaining copy of "TCPIP_Illustrated_Vol-2". The green "Book deleted" |
a608d8ce |
907 | status message should return. But notice that you can now hit the |
ee53cc71 |
908 | "Reload" button in your browser and it just redisplays the book list |
909 | (and it correctly shows it without the "Book deleted" message on |
910 | redisplay). |
d442cc9f |
911 | |
22fe0f18 |
912 | B<NOTE:> Be sure to check out |
913 | L<Authentication|Catalyst::Manual::Tutorial::05_Authentication> where we |
914 | use an improved technique that is better suited to your real world |
915 | applications. |
d442cc9f |
916 | |
917 | |
1cde0fd6 |
918 | =head1 EXPLORING THE POWER OF DBIC |
919 | |
ee53cc71 |
920 | In this section we will explore some additional capabilities offered by |
22fe0f18 |
921 | L<DBIx::Class>. Although these features have relatively little to do |
922 | with Catalyst per se, you will almost certainly want to take advantage |
923 | of them in your applications. |
1cde0fd6 |
924 | |
925 | |
1cde0fd6 |
926 | =head2 Add Datetime Columns to Our Existing Books Table |
927 | |
ee53cc71 |
928 | Let's add two columns to our existing C<books> table to track when each |
929 | book was added and when each book is updated: |
1cde0fd6 |
930 | |
931 | $ sqlite3 myapp.db |
33f1d5d0 |
932 | sqlite> ALTER TABLE book ADD created TIMESTAMP; |
933 | sqlite> ALTER TABLE book ADD updated TIMESTAMP; |
3b1fa91b |
934 | sqlite> UPDATE book SET created = DATETIME('NOW'), updated = DATETIME('NOW'); |
935 | sqlite> SELECT * FROM book; |
f2bbfc36 |
936 | 1|CCSP SNRS Exam Certification Guide|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
937 | 2|TCP/IP Illustrated, Volume 1|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
938 | 3|Internetworking with TCP/IP Vol.1|4|2010-02-16 04:15:45|2010-02-16 04:15:45 |
939 | 4|Perl Cookbook|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
940 | 5|Designing with Web Standards|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
941 | 9|TCP/IP Illustrated, Vol 3|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1cde0fd6 |
942 | sqlite> .quit |
943 | $ |
944 | |
ee53cc71 |
945 | This will modify the C<books> table to include the two new fields and |
946 | populate those fields with the current time. |
1cde0fd6 |
947 | |
acbd7bdd |
948 | |
a46b474e |
949 | =head2 Update DBIx::Class to Automatically Handle the Datetime Columns |
1cde0fd6 |
950 | |
ee53cc71 |
951 | Next, we should re-run the DBIC helper to update the Result Classes with |
952 | the new fields: |
1cde0fd6 |
953 | |
954 | $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \ |
b66dd084 |
955 | create=static components=TimeStamp dbi:SQLite:myapp.db \ |
956 | on_connect_do="PRAGMA foreign_keys = ON" |
1cde0fd6 |
957 | exists "/root/dev/MyApp/script/../lib/MyApp/Model" |
958 | exists "/root/dev/MyApp/script/../t" |
959 | Dumping manual schema for MyApp::Schema to directory /root/dev/MyApp/script/../lib ... |
960 | Schema dump completed. |
961 | exists "/root/dev/MyApp/script/../lib/MyApp/Model/DB.pm" |
962 | |
ee53cc71 |
963 | Notice that we modified our use of the helper slightly: we told it to |
964 | include the L<DBIx::Class::TimeStamp> in the C<load_components> line of |
965 | the Result Classes. |
1cde0fd6 |
966 | |
ee53cc71 |
967 | If you open C<lib/MyApp/Schema/Result/Book.pm> in your editor you should |
968 | see that the C<created> and C<updated> fields are now included in the |
969 | call to C<add_columns()>. However, also notice that the C<many_to_many> |
970 | relationships we manually added below the "C<# DO NOT MODIFY...>" line |
971 | were automatically preserved. |
1cde0fd6 |
972 | |
55490817 |
973 | While we have this file open, let's update it with some additional |
ee53cc71 |
974 | information to have DBIC automatically handle the updating of these two |
975 | fields for us. Insert the following code at the bottom of the file (it |
976 | B<must> be B<below> the "C<# DO NOT MODIFY...>" line and B<above> the |
977 | C<1;> on the last line): |
1cde0fd6 |
978 | |
979 | # |
980 | # Enable automatic date handling |
981 | # |
982 | __PACKAGE__->add_columns( |
983 | "created", |
33f1d5d0 |
984 | { data_type => 'timestamp', set_on_create => 1 }, |
1cde0fd6 |
985 | "updated", |
33f1d5d0 |
986 | { data_type => 'timestamp', set_on_create => 1, set_on_update => 1 }, |
55490817 |
987 | ); |
1cde0fd6 |
988 | |
ee53cc71 |
989 | This will override the definition for these fields that Schema::Loader |
990 | placed at the top of the file. The C<set_on_create> and |
991 | C<set_on_update> options will cause DBIx::Class to automatically update |
992 | the timestamps in these columns whenever a row is created or modified. |
1cde0fd6 |
993 | |
22fe0f18 |
994 | B<Note> that adding the lines above will cause the development server to |
995 | automatically restart if you are running it with the "-r" option. In |
996 | other words, the development server is smart enough to restart not only |
997 | for code under the C<MyApp/Controller/>, C<MyApp/Model/>, and |
998 | C<MyApp/View/> directories, but also under other directions such as our |
999 | "external DBIC model" in C<MyApp/Schema/>. However, also note that it's |
1000 | smart enough to B<not> restart when you edit your C<.tt2> files under |
1001 | C<root/>. |
1002 | |
1cde0fd6 |
1003 | Then enter the following URL into your web browser: |
1004 | |
1005 | http://localhost:3000/books/url_create/TCPIP_Illustrated_Vol-2/5/4 |
1006 | |
22fe0f18 |
1007 | You should get the same "Book Created" screen we saw earlier. However, if |
ee53cc71 |
1008 | you now use the sqlite3 command-line tool to dump the C<books> table, |
1009 | you will see that the new book we added has an appropriate date and time |
1010 | entered for it (see the last line in the listing below): |
1cde0fd6 |
1011 | |
444d6b27 |
1012 | $ sqlite3 myapp.db "select * from book" |
f2bbfc36 |
1013 | 1|CCSP SNRS Exam Certification Guide|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1014 | 2|TCP/IP Illustrated, Volume 1|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1015 | 3|Internetworking with TCP/IP Vol.1|4|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1016 | 4|Perl Cookbook|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1017 | 5|Designing with Web Standards|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1018 | 9|TCP/IP Illustrated, Vol 3|5|2010-02-16 04:15:45|2010-02-16 04:15:45 |
1019 | 10|TCPIP_Illustrated_Vol-2|5|2010-02-16 04:18:42|2010-02-16 04:18:42 |
1cde0fd6 |
1020 | |
55490817 |
1021 | Notice in the debug log that the SQL DBIC generated has changed to |
1cde0fd6 |
1022 | incorporate the datetime logic: |
1023 | |
2a6eb5f9 |
1024 | INSERT INTO book ( created, rating, title, updated ) VALUES ( ?, ?, ?, ? ): |
f2bbfc36 |
1025 | '2010-02-16 04:18:42', '5', 'TCPIP_Illustrated_Vol-2', '2010-02-16 04:18:42' |
2a6eb5f9 |
1026 | INSERT INTO book_author ( author_id, book_id ) VALUES ( ?, ? ): '4', '10' |
1cde0fd6 |
1027 | |
1028 | |
1029 | =head2 Create a ResultSet Class |
1030 | |
444d6b27 |
1031 | An often overlooked but extremely powerful features of DBIC is that it |
55490817 |
1032 | allows you to supply your own subclasses of C<DBIx::Class::ResultSet>. |
22fe0f18 |
1033 | This can be used to pull complex and unsightly "query code" out of your |
1cde0fd6 |
1034 | controllers and encapsulate it in a method of your ResultSet Class. |
ee53cc71 |
1035 | These "canned queries" in your ResultSet Class can then be invoked via a |
1036 | single call, resulting in much cleaner and easier to read controller |
22fe0f18 |
1037 | code (or View code, if that's where you want to call it). |
1cde0fd6 |
1038 | |
55490817 |
1039 | To illustrate the concept with a fairly simple example, let's create a |
ee53cc71 |
1040 | method that returns books added in the last 10 minutes. Start by making |
1041 | a directory where DBIx::Class will look for our ResultSet Class: |
1cde0fd6 |
1042 | |
444d6b27 |
1043 | $ mkdir lib/MyApp/Schema/ResultSet |
1cde0fd6 |
1044 | |
3b1fa91b |
1045 | Then open C<lib/MyApp/Schema/ResultSet/Book.pm> and enter the following: |
1cde0fd6 |
1046 | |
3b1fa91b |
1047 | package MyApp::Schema::ResultSet::Book; |
fce83e5f |
1048 | |
1cde0fd6 |
1049 | use strict; |
1050 | use warnings; |
1051 | use base 'DBIx::Class::ResultSet'; |
fce83e5f |
1052 | |
1cde0fd6 |
1053 | =head2 created_after |
fce83e5f |
1054 | |
1cde0fd6 |
1055 | A predefined search for recently added books |
fce83e5f |
1056 | |
1cde0fd6 |
1057 | =cut |
fce83e5f |
1058 | |
1cde0fd6 |
1059 | sub created_after { |
fadc4ae7 |
1060 | my ($self, $datetime) = @_; |
fce83e5f |
1061 | |
b66dd084 |
1062 | my $date_str = $self->result_source->schema->storage |
fadc4ae7 |
1063 | ->datetime_parser->format_datetime($datetime); |
fce83e5f |
1064 | |
fadc4ae7 |
1065 | return $self->search({ |
1066 | created => { '>' => $date_str } |
1067 | }); |
1cde0fd6 |
1068 | } |
fce83e5f |
1069 | |
1cde0fd6 |
1070 | 1; |
1071 | |
1cde0fd6 |
1072 | Then add the following method to the C<lib/MyApp/Controller/Books.pm>: |
1073 | |
1074 | =head2 list_recent |
fce83e5f |
1075 | |
1cde0fd6 |
1076 | List recently created books |
fce83e5f |
1077 | |
1cde0fd6 |
1078 | =cut |
fce83e5f |
1079 | |
1cde0fd6 |
1080 | sub list_recent :Chained('base') :PathPart('list_recent') :Args(1) { |
1081 | my ($self, $c, $mins) = @_; |
fce83e5f |
1082 | |
1cde0fd6 |
1083 | # Retrieve all of the book records as book model objects and store in the |
1084 | # stash where they can be accessed by the TT template, but only |
1085 | # retrieve books created within the last $min number of minutes |
0ed3df53 |
1086 | $c->stash(books => [$c->model('DB::Book') |
1087 | ->created_after(DateTime->now->subtract(minutes => $mins))]); |
fce83e5f |
1088 | |
1cde0fd6 |
1089 | # Set the TT template to use. You will almost always want to do this |
1090 | # in your action methods (action methods respond to user input in |
1091 | # your controllers). |
0ed3df53 |
1092 | $c->stash(template => 'books/list.tt2'); |
1cde0fd6 |
1093 | } |
1094 | |
ee53cc71 |
1095 | Now try different values for the "minutes" argument (the final number |
1096 | value) using the URL C<http://localhost:3000/books/list_recent/_#_> in |
1097 | your browser. For example, this would list all books added in the last |
1098 | fifteen minutes: |
1cde0fd6 |
1099 | |
1100 | http://localhost:3000/books/list_recent/15 |
1101 | |
ee53cc71 |
1102 | Depending on how recently you added books, you might want to try a |
1103 | higher or lower value for the minutes. |
1cde0fd6 |
1104 | |
1105 | |
1106 | =head2 Chaining ResultSets |
1107 | |
22fe0f18 |
1108 | One of the most helpful and powerful features in C<DBIx::Class> is that |
1109 | it allows you to "chain together" a series of queries (note that this |
1110 | has nothing to do with the "Chained Dispatch" for Catalyst that we were |
1111 | discussing earlier). Because each ResultSet method returns another |
1112 | ResultSet, you can take an initial query and immediately feed that into |
1113 | a second query (and so on for as many queries you need). Note that no |
1114 | matter how many ResultSets you chain together, the database itself will |
1115 | not be hit until you use a method that attempts to access the data. And, |
1116 | because this technique carries over to the ResultSet Class feature we |
ee53cc71 |
1117 | implemented in the previous section for our "canned search", we can |
1118 | combine the two capabilities. For example, let's add an action to our |
1119 | C<Books> controller that lists books that are both recent I<and> have |
1120 | "TCP" in the title. Open up C<lib/MyApp/Controller/Books.pm> and add |
1121 | the following method: |
1cde0fd6 |
1122 | |
acbd7bdd |
1123 | =head2 list_recent_tcp |
fce83e5f |
1124 | |
1cde0fd6 |
1125 | List recently created books |
fce83e5f |
1126 | |
1cde0fd6 |
1127 | =cut |
fce83e5f |
1128 | |
1cde0fd6 |
1129 | sub list_recent_tcp :Chained('base') :PathPart('list_recent_tcp') :Args(1) { |
1130 | my ($self, $c, $mins) = @_; |
fce83e5f |
1131 | |
1cde0fd6 |
1132 | # Retrieve all of the book records as book model objects and store in the |
1133 | # stash where they can be accessed by the TT template, but only |
1134 | # retrieve books created within the last $min number of minutes |
1135 | # AND that have 'TCP' in the title |
22fe0f18 |
1136 | $c->stash(books => [ |
1137 | $c->model('DB::Book') |
1138 | ->created_after(DateTime->now->subtract(minutes => $mins)) |
1139 | ->search({title => {'like', '%TCP%'}}) |
1140 | ]); |
fce83e5f |
1141 | |
1cde0fd6 |
1142 | # Set the TT template to use. You will almost always want to do this |
1143 | # in your action methods (action methods respond to user input in |
1144 | # your controllers). |
0ed3df53 |
1145 | $c->stash(template => 'books/list.tt2'); |
1cde0fd6 |
1146 | } |
1147 | |
f2bbfc36 |
1148 | To try this out, enter the following URL into your browser: |
1cde0fd6 |
1149 | |
1150 | http://localhost:3000/books/list_recent_tcp/100 |
1151 | |
55490817 |
1152 | And you should get a list of books added in the last 100 minutes that |
1153 | contain the string "TCP" in the title. However, if you look at all |
ee53cc71 |
1154 | books within the last 100 minutes, you should get a longer list (again, |
1155 | you might have to adjust the number of minutes depending on how recently |
1156 | you added books to your database): |
1cde0fd6 |
1157 | |
1158 | http://localhost:3000/books/list_recent/100 |
1159 | |
55490817 |
1160 | Take a look at the DBIC_TRACE output in the development server log for |
1cde0fd6 |
1161 | the first URL and you should see something similar to the following: |
1162 | |
fce83e5f |
1163 | SELECT me.id, me.title, me.rating, me.created, me.updated FROM book me |
f2bbfc36 |
1164 | WHERE ( ( title LIKE ? AND created > ? ) ): '%TCP%', '2010-02-16 02:49:32' |
1cde0fd6 |
1165 | |
ee53cc71 |
1166 | However, let's not pollute our controller code with this raw "TCP" query |
1167 | -- it would be cleaner to encapsulate that code in a method on our |
1168 | ResultSet Class. To do this, open C<lib/MyApp/Schema/ResultSet/Book.pm> |
1169 | and add the following method: |
1cde0fd6 |
1170 | |
1171 | =head2 title_like |
fce83e5f |
1172 | |
1cde0fd6 |
1173 | A predefined search for books with a 'LIKE' search in the string |
fce83e5f |
1174 | |
1cde0fd6 |
1175 | =cut |
fce83e5f |
1176 | |
1cde0fd6 |
1177 | sub title_like { |
fadc4ae7 |
1178 | my ($self, $title_str) = @_; |
fce83e5f |
1179 | |
fadc4ae7 |
1180 | return $self->search({ |
1181 | title => { 'like' => "%$title_str%" } |
1182 | }); |
1cde0fd6 |
1183 | } |
1184 | |
55490817 |
1185 | We defined the search string as C<$title_str> to make the method more |
1186 | flexible. Now update the C<list_recent_tcp> method in |
1187 | C<lib/MyApp/Controller/Books.pm> to match the following (we have |
1188 | replaced the C<-E<gt>search> line with the C<-E<gt>title_like> line |
1cde0fd6 |
1189 | shown here -- the rest of the method should be the same): |
1190 | |
1191 | =head2 list_recent_tcp |
fce83e5f |
1192 | |
1cde0fd6 |
1193 | List recently created books |
fce83e5f |
1194 | |
1cde0fd6 |
1195 | =cut |
fce83e5f |
1196 | |
1cde0fd6 |
1197 | sub list_recent_tcp :Chained('base') :PathPart('list_recent_tcp') :Args(1) { |
1198 | my ($self, $c, $mins) = @_; |
fce83e5f |
1199 | |
1cde0fd6 |
1200 | # Retrieve all of the book records as book model objects and store in the |
1201 | # stash where they can be accessed by the TT template, but only |
1202 | # retrieve books created within the last $min number of minutes |
1203 | # AND that have 'TCP' in the title |
22fe0f18 |
1204 | $c->stash(books => [ |
1205 | $c->model('DB::Book') |
1206 | ->created_after(DateTime->now->subtract(minutes => $mins)) |
1207 | ->title_like('TCP') |
1208 | ]); |
fce83e5f |
1209 | |
1cde0fd6 |
1210 | # Set the TT template to use. You will almost always want to do this |
1211 | # in your action methods (action methods respond to user input in |
1212 | # your controllers). |
0ed3df53 |
1213 | $c->stash(template => 'books/list.tt2'); |
1cde0fd6 |
1214 | } |
1215 | |
ee53cc71 |
1216 | Try out the C<list_recent_tcp> and C<list_recent> URLs as we did above. |
1217 | They should work just the same, but our code is obviously cleaner and |
1218 | more modular, while also being more flexible at the same time. |
1cde0fd6 |
1219 | |
1220 | |
1221 | =head2 Adding Methods to Result Classes |
1222 | |
ee53cc71 |
1223 | In the previous two sections we saw a good example of how we could use |
1224 | DBIx::Class ResultSet Classes to clean up our code for an entire query |
1225 | (for example, our "canned searches" that filtered the entire query). We |
1226 | can do a similar improvement when working with individual rows as well. |
1227 | Whereas the ResultSet construct is used in DBIC to correspond to an |
1228 | entire query, the Result Class construct is used to represent a row. |
1229 | Therefore, we can add row-specific "helper methods" to our Result |
1230 | Classes stored in C<lib/MyApp/Schema/Result/>. For example, open |
1231 | C<lib/MyApp/Schema/Result/Author.pm> and add the following method (as |
a46b474e |
1232 | always, it must be above the closing "C<1;>"): |
1cde0fd6 |
1233 | |
1234 | # |
a608d8ce |
1235 | # Row-level helper methods |
1cde0fd6 |
1236 | # |
1237 | sub full_name { |
1238 | my ($self) = @_; |
fce83e5f |
1239 | |
1cde0fd6 |
1240 | return $self->first_name . ' ' . $self->last_name; |
1241 | } |
1242 | |
ee53cc71 |
1243 | This will allow us to conveniently retrieve both the first and last name |
1244 | for an author in one shot. Now open C<root/src/books/list.tt2> and |
1245 | change the definition of C<tt_authors> from this: |
1cde0fd6 |
1246 | |
acbd7bdd |
1247 | ... |
1cde0fd6 |
1248 | [% tt_authors = [ ]; |
fce83e5f |
1249 | tt_authors.push(author.last_name) FOREACH author = book.authors %] |
acbd7bdd |
1250 | ... |
1cde0fd6 |
1251 | |
1252 | to: |
1253 | |
acbd7bdd |
1254 | ... |
1cde0fd6 |
1255 | [% tt_authors = [ ]; |
fce83e5f |
1256 | tt_authors.push(author.full_name) FOREACH author = book.authors %] |
acbd7bdd |
1257 | ... |
1cde0fd6 |
1258 | |
ee53cc71 |
1259 | (Only C<author.last_name> was changed to C<author.full_name> -- the rest |
1260 | of the file should remain the same.) |
1cde0fd6 |
1261 | |
f2bbfc36 |
1262 | Now go to the standard book list URL: |
1cde0fd6 |
1263 | |
1264 | http://localhost:3000/books/list |
1265 | |
55490817 |
1266 | The "Author(s)" column will now contain both the first and last name. |
ee53cc71 |
1267 | And, because the concatenation logic was encapsulated inside our Result |
1268 | Class, it keeps the code inside our TT template nice and clean |
55490817 |
1269 | (remember, we want the templates to be as close to pure HTML markup as |
1270 | possible). Obviously, this capability becomes even more useful as you |
0ed0d69a |
1271 | use it to remove even more complicated row-specific logic from your |
1cde0fd6 |
1272 | templates! |
1273 | |
1274 | |
fce83e5f |
1275 | =head2 Moving Complicated View Code to the Model |
1276 | |
ee53cc71 |
1277 | The previous section illustrated how we could use a Result Class method |
1278 | to print the full names of the authors without adding any extra code to |
1279 | our view, but it still left us with a fairly ugly mess (see |
fce83e5f |
1280 | C<root/src/books/list.tt2>): |
1281 | |
1282 | ... |
1283 | <td> |
1284 | [% # NOTE: See Chapter 4 for a better way to do this! -%] |
1285 | [% # First initialize a TT variable to hold a list. Then use a TT FOREACH -%] |
1286 | [% # loop in 'side effect notation' to load just the last names of the -%] |
1287 | [% # authors into the list. Note that the 'push' TT vmethod does not print -%] |
1288 | [% # a value, so nothing will be printed here. But, if you have something -%] |
1289 | [% # in TT that does return a method and you don't want it printed, you -%] |
1290 | [% # can: 1) assign it to a bogus value, or 2) use the CALL keyword to -%] |
1291 | [% # call it and discard the return value. -%] |
1292 | [% tt_authors = [ ]; |
1293 | tt_authors.push(author.full_name) FOREACH author = book.authors %] |
1294 | [% # Now use a TT 'virtual method' to display the author count in parens -%] |
1295 | [% # Note the use of the TT filter "| html" to escape dangerous characters -%] |
1296 | ([% tt_authors.size | html %]) |
1297 | [% # Use another TT vmethod to join & print the names & comma separators -%] |
1298 | [% tt_authors.join(', ') | html %] |
1299 | </td> |
1300 | ... |
1301 | |
ee53cc71 |
1302 | Let's combine some of the techniques used earlier in this section to |
1303 | clean this up. First, let's add a method to our Book Result Class to |
1304 | return the number of authors for a book. Open |
fce83e5f |
1305 | C<lib/MyApp/Schema/Result/Book.pm> and add the following method: |
1306 | |
444d6b27 |
1307 | =head2 author_count |
1308 | |
1309 | Return the number of authors for the current book |
1310 | |
fce83e5f |
1311 | =cut |
1312 | |
1313 | sub author_count { |
1314 | my ($self) = @_; |
1315 | |
1316 | # Use the 'many_to_many' relationship to fetch all of the authors for the current |
1317 | # and the 'count' method in DBIx::Class::ResultSet to get a SQL COUNT |
1318 | return $self->authors->count; |
1319 | } |
1320 | |
1321 | Next, let's add a method to return a list of authors for a book to the |
1322 | same C<lib/MyApp/Schema/Result/Book.pm> file: |
1323 | |
1324 | =head2 author_list |
1325 | |
1326 | Return a comma-separated list of authors for the current book |
1327 | |
1328 | =cut |
1329 | |
1330 | sub author_list { |
1331 | my ($self) = @_; |
1332 | |
1333 | # Loop through all authors for the current book, calling all the 'full_name' |
1334 | # Result Class method for each |
1335 | my @names; |
1336 | foreach my $author ($self->authors) { |
1337 | push(@names, $author->full_name); |
1338 | } |
1339 | |
1340 | return join(', ', @names); |
1341 | } |
1342 | |
ee53cc71 |
1343 | This method loops through each author, using the C<full_name> Result |
1344 | Class method we added to C<lib/MyApp/Schema/Result/Author.pm> in the |
fce83e5f |
1345 | prior section. |
1346 | |
1347 | Using these two methods, we can simplify our TT code. Open |
1348 | C<root/src/books/list.tt2> and update the "Author(s)" table cell to |
1349 | match the following: |
1350 | |
1351 | ... |
1352 | <td> |
1353 | [% # Print count and author list using Result Class methods -%] |
1354 | ([% book.author_count | html %]) [% book.author_list | html %] |
1355 | </td> |
1356 | ... |
1357 | |
ee53cc71 |
1358 | Although most of the code we removed comprised comments, the overall |
1359 | effect is dramatic... because our view code is so simple, we don't need |
22fe0f18 |
1360 | huge comments to clue people in to the gist of our code. The view code |
ee53cc71 |
1361 | is now self-documenting and readable enough that you could probably get |
22fe0f18 |
1362 | by with no comments at all. All of the "complex" work is being done in |
ee53cc71 |
1363 | our Result Class methods (and, because we have broken the code into |
1364 | nice, modular chunks, the Result Class code is hardly something you |
f2bbfc36 |
1365 | would call complex). |
fce83e5f |
1366 | |
ee53cc71 |
1367 | As we saw in this section, always strive to keep your view AND |
1368 | controller code as simple as possible by pulling code out into your |
22fe0f18 |
1369 | model objects. Because L<DBIx::Class> can be easily extended in so many |
ee53cc71 |
1370 | ways, it's an excellent to way accomplish this objective. It will make |
1371 | your code cleaner, easier to write, less error-prone, and easier to |
1372 | debug and maintain. |
fce83e5f |
1373 | |
ee53cc71 |
1374 | Before you conclude this section, hit Refresh in your browser... the |
1375 | output should be the same even though the backend code has been trimmed |
1376 | down. |
444d6b27 |
1377 | |
fce83e5f |
1378 | |
d442cc9f |
1379 | =head1 AUTHOR |
1380 | |
1381 | Kennedy Clark, C<hkclark@gmail.com> |
1382 | |
53243324 |
1383 | Feel free to contact the author for any errors or suggestions, but the |
1384 | best way to report issues is via the CPAN RT Bug system at |
1385 | <https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>. |
1386 | |
1387 | The most recent version of the Catalyst Tutorial can be found at |
59884771 |
1388 | L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>. |
d442cc9f |
1389 | |
ec3ef4ad |
1390 | Copyright 2006-2010, Kennedy Clark, under the |
1391 | Creative Commons Attribution Share-Alike License Version 3.0 |
95674086 |
1392 | (L<http://creativecommons.org/licenses/by-sa/3.0/us/>). |