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