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