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