3 Catalyst::Manual::Tutorial::03_MoreCatalystBasics - Catalyst Tutorial - Chapter 3: More Catalyst Application Development Basics
8 This is B<Chapter 3 of 10> for the Catalyst tutorial.
10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
16 L<Introduction|Catalyst::Manual::Tutorial::01_Intro>
20 L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics>
24 B<03_More Catalyst Basics>
28 L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
32 L<Authentication|Catalyst::Manual::Tutorial::05_Authentication>
36 L<Authorization|Catalyst::Manual::Tutorial::06_Authorization>
40 L<Debugging|Catalyst::Manual::Tutorial::07_Debugging>
44 L<Testing|Catalyst::Manual::Tutorial::08_Testing>
48 L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD>
52 L<Appendices|Catalyst::Manual::Tutorial::10_Appendices>
59 This chapter of the tutorial builds on the work done in Chapter 2 to
60 explore some features that are more typical of "real world" web
61 applications. From this chapter of the tutorial onward, we will be
62 building a simple book database application. Although the application
63 will be too limited to be of use to anyone, it should provide a basic
64 environment where we can explore a variety of features used in
65 virtually all web applications.
67 You can check out the source code for this example from the Catalyst
68 Subversion repository as per the instructions in
69 L<Catalyst::Manual::Tutorial::01_Intro|Catalyst::Manual::Tutorial::01_Intro>.
72 L<Catalyst::Manual::Tutorial::01_Intro/CATALYST INSTALLATION> before
73 doing the rest of this tutorial. Although the tutorial should work
74 correctly under most any recent version of Perl running on any
75 operating system, the tutorial has been written using Debian 5 and
76 tested to be sure it runs correctly in this environment.
79 =head1 CREATE A NEW APPLICATION
81 The remainder of the tutorial will build an application called C<MyApp>.
82 First use the Catalyst C<catalyst.pl> script to initialize the framework
83 for the C<MyApp> application (make sure you aren't still inside the
84 directory of the C<Hello> application from the previous chapter of the
85 tutorial or in a directory that already has a "MyApp" subdirectory):
89 created "MyApp/script"
93 created "MyApp/script/myapp_create.pl"
94 Change to application directory and Run "perl Makefile.PL" to make sure your install is complete
97 This creates a similar skeletal structure to what we saw in Chapter 2 of
98 the tutorial, except with C<MyApp> and C<myapp> substituted for
99 C<Hello> and C<hello>. (As noted in Chapter 2, omit the ".pl" from
100 the command if you are using Strawberry Perl.)
103 =head1 EDIT THE LIST OF CATALYST PLUGINS
105 One of the greatest benefits of Catalyst is that it has such a large
106 library of plugins and base classes available. Plugins are used to
107 seamlessly integrate existing Perl modules into the overall Catalyst
108 framework. In general, they do this by adding additional methods to the
109 C<context> object (generally written as C<$c>) that Catalyst passes to
110 every component throughout the framework.
112 By default, Catalyst enables three plugins/flags:
120 Enables the Catalyst debug output you saw when we started the
121 C<script/myapp_server.pl> development server earlier. You can remove
122 this item when you place your application into production.
124 To be technically correct, it turns out that C<-Debug> is not a plugin, but a I<flag>.
125 Although most of the items specified on the C<__PACKAGE__-E<gt>setup>
126 line of your application class will be plugins, Catalyst supports a
127 limited number of flag options (of these, C<-Debug> is the most
128 common). See the documentation for C<Catalyst.pm> to get details on
129 other flags (currently C<-Engine>, C<-Home>, and C<-Log>).
131 If you prefer, there are several other ways to enable debug output:
137 Use the C<$c-E<gt>debug> method
141 The C<-d> option to C<script/myapp_server.pl>
145 The C<CATALYST_DEBUG=1> environment variable (or set it to
146 zero to templorarily disable debug output).
150 B<TIP>: Depending on your needs, it can be helpful to permanently
151 remove C<-Debug> from C<lib/MyApp.pm> and then use the C<-d> option
152 to C<script/myapp_server.pl> to re-enable it just for the development
153 server. We will not be using that approach in the tutorial, but feel
154 free to make use of it in your own projects.
158 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
160 C<ConfigLoader> provides an automatic way to load configurable
161 parameters for your application from a central
162 L<Config::General|Config::General> file (versus having the values
163 hard-coded inside your Perl modules). Config::General uses syntax
164 very similar to Apache configuration files. We will see how to use
165 this feature of Catalyst during the authentication and authorization
166 sections (Chapter 5 and Chapter 6).
168 B<IMPORTANT NOTE:> If you are using a version of
169 L<Catalyst::Devel|Catalyst::Devel> prior to version 1.06, be aware
170 that Catalyst changed the default format from YAML to the more
171 straightforward C<Config::General> style. This tutorial uses the
172 newer C<myapp.conf> file for C<Config::General>. However, Catalyst
173 supports both formats and will automatically use either C<myapp.conf>
174 or C<myapp.yml> (or any other format supported by
175 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader> and
176 L<Config::Any|Config::Any>). If you are using a version of
177 Catalyst::Devel prior to 1.06, you can convert to the newer format by
178 simply creating the C<myapp.conf> file manually and deleting
179 C<myapp.yml>. The default contents of the C<myapp.conf> you create
180 should only consist of one line:
184 B<TIP>: This script can be useful for converting between configuration
187 perl -Ilib -e 'use MyApp; use Config::General;
188 Config::General->new->save_file("myapp.conf", MyApp->config);'
192 L<Catalyst::Plugin::Static::Simple|Catalyst::Plugin::Static::Simple>
194 C<Static::Simple> provides an easy way to serve static content, such
195 as images and CSS files, from the development server.
199 For our application, we want to add one new plugin into the mix. To
200 do this, edit C<lib/MyApp.pm> (this file is generally referred to as
201 your I<application class>) and delete the lines with:
209 Then replace it with:
220 B<Note:> Recent versions of C<Catalyst::Devel> have used a variety of
221 techniques to load these plugins/flags. For example, you might see
224 __PACKAGE__->setup(qw/-Debug ConfigLoader Static::Simple/);
226 Don't let these variations confuse you -- they all accomplish the same
229 This tells Catalyst to start using one new plugin,
230 L<Catalyst::Plugin::StackTrace|Catalyst::Plugin::StackTrace>, to add a
231 stack trace to the standard Catalyst "debug screen" (the screen
232 Catalyst sends to your browser when an error occurs). Be aware that
233 L<StackTrace|Catalyst::Plugin::StackTrace> output appears in your
234 browser, not in the console window from which you're running your
235 application, which is where logging output usually goes.
237 Make sure when adding new plugins you also include them as a new
238 dependency within the Makefile.PL file. For example, after adding
239 the StackTrace plugin the Makefile.PL should include the following
242 requires 'Catalyst::Plugin::StackTrace';
251 C<__PACKAGE__> is just a shorthand way of referencing the name of the
252 package where it is used. Therefore, in C<MyApp.pm>, C<__PACKAGE__>
253 is equivalent to C<MyApp>.
257 You will want to disable L<StackTrace|Catalyst::Plugin::StackTrace>
258 before you put your application into production, but it can be helpful
263 When specifying plugins, you can omit C<Catalyst::Plugin::> from the
264 name. Additionally, you can spread the plugin names across multiple
265 lines as shown here or place them all on one line.
270 =head1 CREATE A CATALYST CONTROLLER
272 As discussed earlier, controllers are where you write methods that
273 interact with user input. Typically, controller methods respond to
274 C<GET> and C<POST> requests from the user's web browser.
276 Use the Catalyst C<create> script to add a controller for book-related
279 $ script/myapp_create.pl controller Books
280 exists "/home/me/MyApp/script/../lib/MyApp/Controller"
281 exists "/home/me/MyApp/script/../t"
282 created "/home/me/MyApp/script/../lib/MyApp/Controller/Books.pm"
283 created "/home/me/MyApp/script/../t/controller_Books.t"
285 Then edit C<lib/MyApp/Controller/Books.pm> (as discussed in Chapter 2 of
286 the Tutorial, Catalyst has a separate directory under C<lib/MyApp> for
287 each of the three parts of MVC: C<Model>, C<View>, and C<Controller>)
288 and add the following method to the controller:
292 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
297 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
298 # 'Context' that's used to 'glue together' the various components
299 # that make up the application
302 # Retrieve all of the book records as book model objects and store in the
303 # stash where they can be accessed by the TT template
304 # $c->stash->{books} = [$c->model('DB::Book')->all];
305 # But, for now, use this code until we create the model later
306 $c->stash->{books} = '';
308 # Set the TT template to use. You will almost always want to do this
309 # in your action methods (action methods respond to user input in
311 $c->stash->{template} = 'books/list.tt2';
314 B<TIP>: See Appendix 1 for tips on removing the leading spaces when
315 cutting and pasting example code from POD-based documents.
317 Programmers experienced with object-oriented Perl should recognize
318 C<$self> as a reference to the object where this method was called.
319 On the other hand, C<$c> will be new to many Perl programmers who have
320 not used Catalyst before (it's sometimes written as C<$context>). The
321 Context object is automatically passed to all Catalyst components. It
322 is used to pass information between components and provide access to
323 Catalyst and plugin functionality.
325 Catalyst actions are regular Perl methods, but they make use of
326 attributes (the "C<: Local>" next to the "C<sub list>" in the code
327 above) to provide additional information to the Catalyst dispatcher
328 logic (note that the space between the colon and the attribute name is
329 optional; you will see attributes written both ways). Most Catalyst
330 Controllers use one of five action types:
336 B<:Private> -- Use C<:Private> for methods that you want to make into
337 an action, but you do not want Catalyst to directly expose the method
338 to your users. Catalyst will not map C<:Private> methods to a URI.
339 Use them for various sorts of "special" methods (the C<begin>,
340 C<auto>, etc. discussed below) or for methods you want to be able to
341 C<forward> or C<detach> to. (If the method is a plain old "helper
342 method" that you don't want to be an action at all, then just define
343 the method without any attribute -- you can call it in your code, but
344 the Catalyst dispatcher will ignore it.)
346 There are five types of "special" build-in C<:Private> actions:
347 C<begin>, C<end>, C<default>, C<index>, and C<auto>.
353 With C<begin>, C<end>, C<default>, C<index> private actions, only the
354 most specific action of each type will be called. For example, if you
355 define a C<begin> action in your controller it will I<override> a
356 C<begin> action in your application/root controller -- I<only> the
357 action in your controller will be called.
361 Unlike the other actions where only a single method is called for each
362 request, I<every> auto action along the chain of namespaces will be
363 called. Each C<auto> action will be called I<from the application/root
364 controller down through the most specific class>.
370 B<:Path> -- C<:Path> actions let you map a method to an explicit URI
371 path. For example, "C<:Path('list')>" in
372 C<lib/MyApp/Controller/Books.pm> would match on the URL
373 C<http://localhost:3000/books/list>, but "C<:Path('/list')>" would
374 match on C<http://localhost:3000/list> (because of the leading slash).
375 You can use C<:Args()> to specify how many arguments an action should
376 accept. See L<Catalyst::Manual::Intro/Action_types> for more
377 information and examples.
381 B<:Local> -- C<:Local> is merely a shorthand for
382 "C<:Path('_name_of_method_')>". For example, these are equivalent:
383 "C<sub create_book :Local {...}>" and
384 "C<sub create_book :Path('create_book') {...}>".
388 B<:Global> -- C<:Global> is merely a shorthand for
389 "C<:Path('/_name_of_method_')>". For example, these are equivalent:
390 "C<sub create_book :Global {...}>" and
391 "C<sub create_book :Path('/create_book') {...}>".
395 B<:Chained> -- Newer Catalyst applications tend to use the Chained
396 dispatch form of action types because of its power and flexibility.
397 It allows a series of controller methods to be automatically dispatched
398 to service a single user request. See
399 L<Catalyst::Manual::Tutorial::04_BasicCRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
400 and L<Catalyst::DispatchType::Chained|Catalyst::DispatchType::Chained>
401 for more information on chained actions.
405 You should refer to L<Catalyst::Manual::Intro/Action_types> for
406 additional information and for coverage of some lesser-used action
407 types not discussed here (C<Regex> and C<LocalRegex>).
410 =head1 CATALYST VIEWS
412 As mentioned in Chapter 2 of the tutorial, views are where you render
413 output, typically for display in the user's web browser (but also
414 possibly using into output-generation systems, such as PDF or JSON).
415 The code in C<lib/MyApp/View> selects the I<type> of view to use, with
416 the actual rendering template found in the C<root> directory. As with
417 virtually every aspect of Catalyst, options abound when it comes to the
418 specific view technology you adopt inside your application. However,
419 most Catalyst applications use the Template Toolkit, known as TT (for
420 more information on TT, see L<http://www.template-toolkit.org>). Other
421 somewhat popular view technologies include Mason
422 (L<http://www.masonhq.com> and L<http://www.masonbook.com>) and
423 L<HTML::Template> (L<http://html-template.sourceforge.net>).
426 =head2 Create a Catalyst View
428 When using TT for the Catalyst view, the main helper script
429 is L<Catalyst::Helper::View::TT|Catalyst::Helper::View::TT>.
430 You may also come across references to
431 L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite>,
432 but its use is now deprecated.
434 Enter the following command to enable the C<TT> style of view
435 rendering for this tutorial:
437 $ script/myapp_create.pl view TT TT
438 exists "/home/me/MyApp/script/../lib/MyApp/View"
439 exists "/home/me/MyApp/script/../t"
440 created "/home/me/MyApp/script/../lib/MyApp/View/TT.pm"
441 created "/home/me/MyApp/script/../t/view_TT.t"
443 This simply creates a view called C<TT> (the second 'TT' argument) in
444 a file called C<TT.pm> (the first 'TT' argument). It is now up to you
445 to decide how you want to structure your view layout. For the
446 tutorial, we will start with a very simple TT template to initially
447 demonstrate the concepts, but quickly migrate to a more typical
448 "wrapper page" type of configuration (where the "wrapper" controls the
449 overall "look and feel" of your site from a single file or set of
452 Edit C<lib/MyApp/View/TT.pm> and you should see that the default
453 contents contains something similar to the following:
455 __PACKAGE__->config(TEMPLATE_EXTENSION => '.tt');
457 And update it to match:
460 # Change default TT extension
461 TEMPLATE_EXTENSION => '.tt2',
462 # Set the location for TT files
464 MyApp->path_to( 'root', 'src' ),
468 B<NOTE:> Make sure to add a comma after '.tt2' outside the single
471 This changes the default extension for Template Toolkit from '.tt' to
472 '.tt2' and changes the base directory for your template files from
473 C<root> to C<root/src>. Stick with these conventions for the
474 tutorial, but feel free to use whatever options you desire in your
475 applications (as with most things Perl, there's more than one way to
478 B<Note:> We will use C<root/src> as the base directory for our
479 template files, with a full naming convention of
480 C<root/src/_controller_name_/_action_name_.tt2>. Another popular option is to
481 use C<root/> as the base (with a full filename pattern of
482 C<root/_controller_name_/_action_name_.tt2>).
485 =head2 Create a TT Template Page
487 First create a directory for book-related TT templates:
489 $ mkdir -p root/src/books
491 Then create C<root/src/books/list.tt2> in your editor and enter:
493 [% # This is a TT comment. The '-' at the end "chomps" the newline. You won't -%]
494 [% # see this "chomping" in your browser because HTML ignores blank lines, but -%]
495 [% # it WILL eliminate a blank line if you view the HTML source. It's purely -%]
496 [%- # optional, but both the beginning and the ending TT tags support chomping. -%]
498 [% # Provide a title -%]
499 [% META title = 'Book List' -%]
502 <tr><th>Title</th><th>Rating</th><th>Author(s)</th></tr>
503 [% # Display each book in a table row %]
504 [% FOREACH book IN books -%]
506 <td>[% book.title %]</td>
507 <td>[% book.rating %]</td>
513 As indicated by the inline comments above, the C<META title> line uses
514 TT's META feature to provide a title to the "wrapper" that we will
515 create later. Meanwhile, the C<FOREACH> loop iterates through each
516 C<book> model object and prints the C<title> and C<rating> fields.
518 The C<[%> and C<%]> tags are used to delimit Template Toolkit code. TT
519 supports a wide variety of directives for "calling" other files,
520 looping, conditional logic, etc. In general, TT simplifies the usual
521 range of Perl operators down to the single dot (".") operator. This
522 applies to operations as diverse as method calls, hash lookups, and list
524 L<http://search.cpan.org/perldoc?Template::Manual::Variables> for
525 details and examples). In addition to the usual L<Template> module Pod
526 documentation, you can access the TT manual at
527 L<http://search.cpan.org/perldoc?Template::Manual>.
529 B<TIP:> While you can build all sorts of complex logic into your TT
530 templates, you should in general keep the "code" part of your
531 templates as simple as possible. If you need more complex logic,
532 create helper methods in your model that abstract out a set of code
533 into a single call from your TT template. (Note that the same is true
534 of your controller logic as well -- complex sections of code in your
535 controllers should often be pulled out and placed into your model
536 objects.) In Chapter 4 of the tutorial we will explore some extremely
537 helpful and powerful features of L<DBIx::Class> that allow you to pull
538 code out of your views and controllers and place it where it
539 rightfully belongs in a model class.
542 =head2 Test Run The Application
544 To test your work so far, first start the development server:
546 $ script/myapp_server.pl
548 Then point your browser to L<http://localhost:3000> and you should
549 still get the Catalyst welcome page. Next, change the URL in your
550 browser to L<http://localhost:3000/books/list>. If you have
551 everything working so far, you should see a web page that displays
552 nothing other than our column headers for "Title", "Rating", and
553 "Author(s)" -- we will not see any books until we get the database and
556 If you run into problems getting your application to run correctly, it
557 might be helpful to refer to some of the debugging techniques covered in
558 the L<Debugging|Catalyst::Manual::Tutorial::07_Debugging> chapter of the
562 =head1 CREATE A SQLITE DATABASE
564 In this step, we make a text file with the required SQL commands to
565 create a database table and load some sample data. We will use
566 SQLite (L<http://www.sqlite.org>), a popular database that is
567 lightweight and easy to use. Be sure to get at least version 3. Open
568 C<myapp01.sql> in your editor and enter:
570 PRAGMA foreign_keys = ON;
572 -- Create a very simple database to hold book and author information
575 id INTEGER PRIMARY KEY,
579 -- 'book_author' is a many-to-many join table between books & authors
580 CREATE TABLE book_author (
581 book_id INTEGER REFERENCES book(id) ON DELETE CASCADE ON UPDATE CASCADE,
582 author_id INTEGER REFERENCES author(id) ON DELETE CASCADE ON UPDATE CASCADE,
583 PRIMARY KEY (book_id, author_id)
585 CREATE TABLE author (
586 id INTEGER PRIMARY KEY,
591 --- Load some sample data
593 INSERT INTO book VALUES (1, 'CCSP SNRS Exam Certification Guide', 5);
594 INSERT INTO book VALUES (2, 'TCP/IP Illustrated, Volume 1', 5);
595 INSERT INTO book VALUES (3, 'Internetworking with TCP/IP Vol.1', 4);
596 INSERT INTO book VALUES (4, 'Perl Cookbook', 5);
597 INSERT INTO book VALUES (5, 'Designing with Web Standards', 5);
598 INSERT INTO author VALUES (1, 'Greg', 'Bastien');
599 INSERT INTO author VALUES (2, 'Sara', 'Nasseh');
600 INSERT INTO author VALUES (3, 'Christian', 'Degu');
601 INSERT INTO author VALUES (4, 'Richard', 'Stevens');
602 INSERT INTO author VALUES (5, 'Douglas', 'Comer');
603 INSERT INTO author VALUES (6, 'Tom', 'Christiansen');
604 INSERT INTO author VALUES (7, 'Nathan', 'Torkington');
605 INSERT INTO author VALUES (8, 'Jeffrey', 'Zeldman');
606 INSERT INTO book_author VALUES (1, 1);
607 INSERT INTO book_author VALUES (1, 2);
608 INSERT INTO book_author VALUES (1, 3);
609 INSERT INTO book_author VALUES (2, 4);
610 INSERT INTO book_author VALUES (3, 5);
611 INSERT INTO book_author VALUES (4, 6);
612 INSERT INTO book_author VALUES (4, 7);
613 INSERT INTO book_author VALUES (5, 8);
615 Then use the following command to build a C<myapp.db> SQLite database:
617 $ sqlite3 myapp.db < myapp01.sql
619 If you need to create the database more than once, you probably want to
620 issue the C<rm myapp.db> command to delete the database before you use
621 the C<sqlite3 myapp.db E<lt> myapp01.sql> command.
623 Once the C<myapp.db> database file has been created and initialized, you
624 can use the SQLite command line environment to do a quick dump of the
629 Enter ".help" for instructions
630 sqlite> select * from book;
631 1|CCSP SNRS Exam Certification Guide|5
632 2|TCP/IP Illustrated, Volume 1|5
633 3|Internetworking with TCP/IP Vol.1|4
635 5|Designing with Web Standards|5
641 $ sqlite3 myapp.db "select * from book"
642 1|CCSP SNRS Exam Certification Guide|5
643 2|TCP/IP Illustrated, Volume 1|5
644 3|Internetworking with TCP/IP Vol.1|4
646 5|Designing with Web Standards|5
648 As with most other SQL tools, if you are using the full "interactive"
649 environment you need to terminate your SQL commands with a ";" (it's not
650 required if you do a single SQL statement on the command line). Use
651 ".q" to exit from SQLite from the SQLite interactive mode and return to
652 your OS command prompt.
654 Please note that here we have chosen to use 'singular' table names. This is
655 because the default inflection code for older versions of
656 L<DBIx::Class::Schema::Loader> does NOT handle plurals. There has been much
657 philosophical discussion on whether table names should be plural or singular.
658 There is no one correct answer, as long as one makes a choice and remains
659 consistent with it. If you prefer plural table names (e.g. you think that they
660 are easier to read) then see the documentation in
661 L<DBIx::Class::Schema::Loader::Base/naming> (version 0.05 or greater).
663 For using other databases, such as PostgreSQL or MySQL, see
664 L<Appendix 2|Catalyst::Manual::Tutorial::10_Appendices>.
667 =head1 DATABASE ACCESS WITH DBIx::Class
669 Catalyst can be used with virtually any form of datastore available
670 via Perl. For example, L<Catalyst::Model::DBI|Catalyst::Model::DBI>
671 can be used to access databases through the traditional Perl L<DBI>
672 interface or you can use a model to access files of any type on the
673 filesystem. However, most Catalyst applications use some form of
674 object-relational mapping (ORM) technology to create objects
675 associated with tables in a relational database. Matt Trout's
676 L<DBIx::Class|DBIx::Class> (abbreviated as "DBIC") has rapidly emerged
677 as the Perl-based ORM technology of choice. Most new Catalyst
678 applications rely on DBIx::Class, as will this tutorial.
680 Although DBIx::Class has included support for a C<create=dynamic> mode
681 to automatically read the database structure every time the
682 application starts, it's use is no longer recommended. While it can
683 make for "flashy" demos, the use of the C<create=static> mode we use
684 below can be implemented just as quickly and provides many advantages
685 (such as the ability to add your own methods to the overall DBIC
686 framework, a technique that we see in Chapter 4).
689 =head2 Make Sure You Have a Recent Version of the DBIx::Class Model
691 First, let's be sure we have a recent version of the DBIC helper,
692 L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema>, by
693 running this command:
695 $ perl -MCatalyst::Model::DBIC::Schema -e \
696 'print "$Catalyst::Model::DBIC::Schema::VERSION\n"'
699 Please note the '\' above. Depending on your environment, you might
700 be able to cut and paste the text as shown or need to remove the '\'
701 character to that the command is all on a single line.
703 You should have version 0.31 or greater if you are following along
704 with Debian 5. In other environments, you may need to run this
705 command to install it directly from CPAN:
707 $ sudo cpan Catalyst::Model::DBIC::Schema
709 And re-run the version print command to verify that you are now at
712 Please use version C<1.27> of L<DBD::SQLite> or later for proper foreign key
715 =head2 Create Static DBIx::Class Schema Files
717 Before you continue, make sure your C<myapp.db> database file is in
718 the application's topmost directory. Now use the model helper with
719 the C<create=static> option to read the database with
720 L<DBIx::Class::Schema::Loader|DBIx::Class::Schema::Loader> and
721 automatically build the required files for us:
723 $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
724 create=static dbi:SQLite:myapp.db \
725 on_connect_do="PRAGMA foreign_keys = ON"
726 exists "/home/me/MyApp/script/../lib/MyApp/Model"
727 exists "/home/me/MyApp/script/../t"
728 Dumping manual schema for MyApp::Schema to directory /home/me/MyApp/script/../lib ...
729 Schema dump completed.
730 created "/home/me/MyApp/script/../lib/MyApp/Model/DB.pm"
731 created "/home/me/MyApp/script/../t/model_DB.t"
733 Please note the '\' above. Depending on your environment, you might
734 be able to cut and paste the text as shown or need to remove the '\'
735 character to that the command is all on a single line.
737 The C<script/myapp_create.pl> command breaks down like this:
743 C<DB> is the name of the model class to be created by the helper in
748 C<DBIC::Schema> is the type of the model to create.
752 C<MyApp::Schema> is the name of the DBIC schema file written to
753 C<lib/MyApp/Schema.pm>.
757 C<create=static> causes
758 L<DBIx::Class::Schema::Loader|DBIx::Class::Schema::Loader> to
759 load the schema as it runs and then write that information out
764 And finally, C<dbi:SQLite:myapp.db> is the standard DBI connect string
769 If you look in the C<lib/MyApp/Schema.pm> file, you will find that it
770 only contains a call to the C<load_namespaces> method. You will also
771 find that C<lib/MyApp> contains a C<Schema> subdirectory, which then
772 has a subdirectory called "Result". This "Result" subdirectory then
773 has files named according to each of the tables in our simple database
774 (C<Author.pm>, C<BookAuthor.pm>, and C<Book.pm>). These three
775 files are called "Result Classes" in DBIx::Class nomenclature. Although the
776 Result Class files are named after tables in our database, the classes
777 correspond to the I<row-level data> that is returned by DBIC (more on
778 this later, especially in
779 L<Catalyst::Manual::Tutorial::04_BasicCRUD/EXPLORING THE POWER OF DBIC>).
781 The idea with the Result Source files created under
782 C<lib/MyApp/Schema/Result> by the C<create=static> option is to only
783 edit the files below the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
784 warning. If you place all of your changes below that point in the
785 file, you can regenerate the automatically created information at the
786 top of each file should your database structure get updated.
788 Also note the "flow" of the model information across the various files
789 and directories. Catalyst will initially load the model from
790 C<lib/MyApp/Model/DB.pm>. This file contains a reference to
791 C<lib/MyApp/Schema.pm>, so that file is loaded next. Finally, the
792 call to C<load_namespaces> in C<Schema.pm> will load each of the
793 "Result Class" files from the C<lib/MyApp/Schema/Result> subdirectory.
794 The final outcome is that Catalyst will dynamically create three
795 table-specific Catalyst models every time the application starts (you
796 can see these three model files listed in the debug output generated
797 when you launch the application).
799 B<NOTE:> Older versions of
800 L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema> use the
801 deprecated DBIx::Class C<load_classes> technique instead of the newer
802 C<load_namspaces>. For new applications, please try to use
803 C<load_namespaces> since it more easily supports a very useful DBIC
804 technique called "ResultSet Classes." If you need to convert an
805 existing application from "load_classes" to "load_namespaces," you can
806 use this process to automate the migration, but first make sure you have
807 version C<0.39> of L<Catalyst::Model::DBIC::Schema> and
808 L<DBIx::Class::Schema::Loader> version C<0.05000> or later.
810 $ # Re-run the helper to upgrade for you
811 $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
812 create=static naming=current use_namespaces=1 \
813 dbi:SQLite:myapp.db \
814 on_connect_do="PRAGMA foreign_keys = ON"
816 =head1 ENABLE THE MODEL IN THE CONTROLLER
818 Open C<lib/MyApp/Controller/Books.pm> and un-comment the model code we
819 left disabled earlier so that your version matches the following (un-
820 comment the line containing C<[$c-E<gt>model('DB::Book')-E<gt>all]>
821 and delete the next 2 lines):
825 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
830 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
831 # 'Context' that's used to 'glue together' the various components
832 # that make up the application
835 # Retrieve all of the book records as book model objects and store in the
836 # stash where they can be accessed by the TT template
837 $c->stash->{books} = [$c->model('DB::Book')->all];
839 # Set the TT template to use. You will almost always want to do this
840 # in your action methods (action methods respond to user input in
842 $c->stash->{template} = 'books/list.tt2';
845 B<TIP>: You may see the C<$c-E<gt>model('DB::Book')> un-commented
846 above written as C<$c-E<gt>model('DB')-E<gt>resultset('Book')>. The
847 two are equivalent. Either way, C<$c-E<gt>model> returns a
848 L<DBIx::Class::ResultSet|DBIx::Class::ResultSet> which handles queries
849 against the database and iterating over the set of results that is
852 We are using the C<-E<gt>all> to fetch all of the books. DBIC
853 supports a wide variety of more advanced operations to easily do
854 things like filtering and sorting the results. For example, the
855 following could be used to sort the results by descending title:
857 $c->model('DB::Book')->search({}, {order_by => 'title DESC'});
859 Some other examples are provided in
860 L<DBIx::Class::Manual::Cookbook/Complex WHERE clauses>, with
861 additional information found at L<DBIx::Class::ResultSet/search>,
862 L<DBIx::Class::Manual::FAQ/Searching>,
863 L<DBIx::Class::Manual::Intro|DBIx::Class::Manual::Intro>
864 and L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema>.
867 =head2 Test Run The Application
869 First, let's enable an environment variable that causes DBIx::Class to
870 dump the SQL statements used to access the database. This is a
871 helpful trick when you are trying to debug your database-oriented
874 $ export DBIC_TRACE=1
876 This assumes you are using bash as your shell -- adjust accordingly if
877 you are using a different shell (for example, under tcsh, use
878 C<setenv DBIC_TRACE 1>).
880 B<NOTE:> You can also set this in your code using
881 C<$class-E<gt>storage-E<gt>debug(1);>. See
882 L<DBIx::Class::Manual::Troubleshooting> for details (including options
883 to log to a file instead of displaying to the Catalyst development server
886 Then launch the Catalyst development server. The log output should
887 display something like:
889 $ script/myapp_server.pl
890 [debug] Debug messages enabled
891 [debug] Statistics enabled
892 [debug] Loaded plugins:
893 .----------------------------------------------------------------------------.
894 | Catalyst::Plugin::ConfigLoader 0.27 |
895 | Catalyst::Plugin::StackTrace 0.11 |
896 | Catalyst::Plugin::Static::Simple 0.25 |
897 '----------------------------------------------------------------------------'
899 [debug] Loaded dispatcher "Catalyst::Dispatcher"
900 [debug] Loaded engine "Catalyst::Engine::HTTP"
901 [debug] Found home "/home/me/MyApp"
902 [debug] Loaded Config "/home/me/MyApp/myapp.conf"
903 [debug] Loaded components:
904 .-----------------------------------------------------------------+----------.
906 +-----------------------------------------------------------------+----------+
907 | MyApp::Controller::Books | instance |
908 | MyApp::Controller::Root | instance |
909 | MyApp::Model::DB | instance |
910 | MyApp::Model::DB::Author | class |
911 | MyApp::Model::DB::Book | class |
912 | MyApp::Model::DB::BookAuthor | class |
913 | MyApp::View::TT | instance |
914 '-----------------------------------------------------------------+----------'
916 [debug] Loaded Private actions:
917 .----------------------+--------------------------------------+--------------.
918 | Private | Class | Method |
919 +----------------------+--------------------------------------+--------------+
920 | /default | MyApp::Controller::Root | default |
921 | /end | MyApp::Controller::Root | end |
922 | /index | MyApp::Controller::Root | index |
923 | /books/index | MyApp::Controller::Books | index |
924 | /books/list | MyApp::Controller::Books | list |
925 '----------------------+--------------------------------------+--------------'
927 [debug] Loaded Path actions:
928 .-------------------------------------+--------------------------------------.
930 +-------------------------------------+--------------------------------------+
933 | /books | /books/index |
934 | /books/list | /books/list |
935 '-------------------------------------+--------------------------------------'
937 [info] MyApp powered by Catalyst 5.80013
938 You can connect to your server at http://debian:3000
940 B<NOTE:> Be sure you run the C<script/myapp_server.pl> command from
941 the 'base' directory of your application, not inside the C<script>
942 directory itself or it will not be able to locate the C<myapp.db>
943 database file. You can use a fully qualified or a relative path to
944 locate the database file, but we did not specify that when we ran the
945 model helper earlier.
947 Some things you should note in the output above:
953 Catalyst::Model::DBIC::Schema dynamically created three model classes,
954 one to represent each of the three tables in our database
955 (C<MyApp::Model::DB::Author>, C<MyApp::Model::DB::BookAuthor>,
956 and C<MyApp::Model::DB::Book>).
960 The "list" action in our Books controller showed up with a path of
965 Point your browser to L<http://localhost:3000> and you should still get
966 the Catalyst welcome page.
968 Next, to view the book list, change the URL in your browser to
969 L<http://localhost:3000/books/list>. You should get a list of the five
970 books loaded by the C<myapp01.sql> script above without any formatting.
971 The rating for each book should appear on each row, but the "Author(s)"
972 column will still be blank (we will fill that in later).
974 Also notice in the output of the C<script/myapp_server.pl> that
975 DBIx::Class used the following SQL to retrieve the data:
977 SELECT me.id, me.title, me.rating FROM book me
979 because we enabled DBIC_TRACE.
981 You now have the beginnings of a simple but workable web application.
982 Continue on to future sections and we will develop the application
986 =head1 CREATE A WRAPPER FOR THE VIEW
988 When using TT, you can (and should) create a wrapper that will
989 literally wrap content around each of your templates. This is
990 certainly useful as you have one main source for changing things that
991 will appear across your entire site/application instead of having to
992 edit many individual files.
995 =head2 Configure TT.pm For The Wrapper
997 In order to create a wrapper, you must first edit your TT view and
998 tell it where to find your wrapper file.
1000 Edit you TT view in C<lib/MyApp/View/TT.pm> and change it to match the
1003 __PACKAGE__->config(
1004 # Change default TT extension
1005 TEMPLATE_EXTENSION => '.tt2',
1006 # Set the location for TT files
1008 MyApp->path_to( 'root', 'src' ),
1010 # Set to 1 for detailed timer stats in your HTML as comments
1012 # This is your wrapper template located in the 'root/src'
1013 WRAPPER => 'wrapper.tt2',
1017 =head2 Create the Wrapper Template File and Stylesheet
1019 Next you need to set up your wrapper template. Basically, you'll want
1020 to take the overall layout of your site and put it into this file.
1021 For the tutorial, open C<root/src/wrapper.tt2> and input the following:
1023 <?xml version="1.0" encoding="UTF-8"?>
1024 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1025 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1027 <title>[% template.title or "My Catalyst App!" %]</title>
1028 <link rel="stylesheet" href="[% c.uri_for('/static/css/main.css') %]" />
1034 [%# Your logo could go here -%]
1035 <img src="[% c.uri_for('/static/images/btn_88x31_powered.png') %]" />
1036 [%# Insert the page title -%]
1037 <h1>[% template.title or site.title %]</h1>
1040 <div id="bodyblock">
1044 <li><a href="[% c.uri_for('/books/list') %]">Home</a></li>
1045 <li><a href="[% c.uri_for('/') %]" title="Catalyst Welcome Page">Welcome</a></li>
1047 </div><!-- end menu -->
1050 [%# Status and error messages %]
1051 <span class="message">[% status_msg %]</span>
1052 <span class="error">[% error_msg %]</span>
1053 [%# This is where TT will stick all of your template's contents. -%]
1055 </div><!-- end content -->
1056 </div><!-- end bodyblock -->
1058 <div id="footer">Copyright (c) your name goes here</div>
1059 </div><!-- end outer -->
1064 Notice the status and error message sections in the code above:
1066 <span class="status">[% status_msg %]</span>
1067 <span class="error">[% error_msg %]</span>
1069 If we set either message in the Catalyst stash (e.g.,
1070 C<$c-E<gt>stash-E<gt>{status_msg} = 'Request was successful!'>) it
1071 will be displayed whenever any view used by that request is rendered.
1072 The C<message> and C<error> CSS styles can be customized to suit your
1073 needs in the C<root/static/css/main.css> file we create below.
1081 The Catalyst stash only lasts for a single HTTP request. If
1082 you need to retain information across requests you can use
1083 L<Catalyst::Plugin::Session|Catalyst::Plugin::Session> (we will use
1084 Catalyst sessions in the Authentication chapter of the tutorial).
1088 Although it is beyond the scope of this tutorial, you may wish to use
1089 a JavaScript or AJAX tool such as jQuery (L<http://www.jquery.com>) or
1090 Dojo (L<http://www.dojotoolkit.org>).
1095 =head3 Create A Basic Stylesheet
1097 First create a central location for stylesheets under the static
1100 $ mkdir root/static/css
1102 Then open the file C<root/static/css/main.css> (the file referenced in
1103 the stylesheet href link of our wrapper above) and add the following
1122 background-color: #ddd;
1128 padding: 0 0 50% 5px;
1129 font-weight: normal;
1130 background-color: #ddd;
1143 You may wish to check out a "CSS Framework" like Emastic
1144 (L<http://code.google.com/p/emastic/>) as a way to quickly
1145 provide lots of high-quality CSS functionality.
1148 =head2 Test Run The Application
1150 Restart the development server and hit "Reload" in your web browser
1151 and you should now see a formatted version of our basic book list.
1152 Although our wrapper and stylesheet are obviously very simple, you
1153 should see how it allows us to control the overall look of an entire
1154 website from two central files. To add new pages to the site, just
1155 provide a template that fills in the C<content> section of our wrapper
1156 template -- the wrapper will provide the overall feel of the page.
1159 =head2 Updating the Generated DBIx::Class Result Class Files
1161 Let's manually add some relationship information to the auto-generated
1162 Result Class files. C<many_to_many> relationships are not currently
1163 automatically generated by L<DBIx::Class::Schema::Loader>.
1164 First edit C<lib/MyApp/Schema/Result/Book.pm> and add the
1165 following text below the C<# You can replace this text...> comment:
1169 # 1) Name of relationship, DBIC will create accessor with this name
1170 # 2) Name of has_many() relationship this many_to_many() is shortcut for
1171 # 3) Name of belongs_to() relationship in model class of has_many() above
1172 # You must already have the has_many() defined to use a many_to_many().
1173 __PACKAGE__->many_to_many(authors => 'book_authors', 'author');
1175 B<Note:> Be careful to put this code I<above> the C<1;> at the end of the
1176 file. As with any Perl package, we need to end the last line with
1177 a statement that evaluates to C<true>. This is customarily done with
1178 C<1;> on a line by itself.
1180 You'll notice there is already a C<has_many> relationship called
1181 C<book_authors>. The C<many_to_many> relationship is optional, but it makes it
1182 easier to map a book to its collection of authors. Without
1183 it, we would have to "walk" though the C<book_author> table as in
1184 C<$book-E<gt>book_author-E<gt>first-E<gt>author-E<gt>last_name> (we
1185 will see examples on how to use DBIx::Class objects in your code soon,
1186 but note that because C<$book-E<gt>book_author> can return multiple
1187 authors, we have to use C<first> to display a single author).
1188 C<many_to_many> allows us to use the shorter
1189 C<$book-E<gt>author-E<gt>first-E<gt>last_name>. Note that you cannot
1190 define a C<many_to_many> relationship without also having the
1191 C<has_many> relationship in place.
1193 Then edit C<lib/MyApp/Schema/Result/Author.pm> and add relationship
1194 information as follows (again, be careful to put in above the C<1;> but
1195 below the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment):
1199 # 1) Name of relationship, DBIC will create accessor with this name
1200 # 2) Name of has_many() relationship this many_to_many() is shortcut for
1201 # 3) Name of belongs_to() relationship in model class of has_many() above
1202 # You must already have the has_many() defined to use a many_to_many().
1203 __PACKAGE__->many_to_many(books => 'book_authors', 'book');
1205 =head2 Run The Application
1207 Run the Catalyst development server script with the C<DBIC_TRACE> option
1208 (it might still be enabled from earlier in the tutorial, but here is an
1209 alternate way to specify the option just in case):
1211 $ DBIC_TRACE=1 script/myapp_server.pl
1213 Make sure that the application loads correctly and that you see the
1214 three dynamically created model class (one for each of the
1215 Result Classes we created).
1217 Then hit the URL L<http://localhost:3000/books/list> with your browser
1218 and be sure that the book list still displays correctly. You can leave
1219 the development server running for the next step if you wish.
1221 B<Note:> You will not see the authors yet because the view does not yet
1222 use the new relations. Read on to the next section where we update the
1223 template to do that.
1226 =head1 UPDATING THE VIEW
1228 Let's add a new column to our book list page that takes advantage of
1229 the relationship information we manually added to our schema files in
1230 the previous section. Edit C<root/src/books/list.tt2> and replace
1231 the "empty" table cell "<td></td>" with the following:
1235 [% # NOTE: See Chapter 4 for a better way to do this! -%]
1236 [% # First initialize a TT variable to hold a list. Then use a TT FOREACH -%]
1237 [% # loop in 'side effect notation' to load just the last names of the -%]
1238 [% # authors into the list. Note that the 'push' TT vmethod doesn't return -%]
1239 [% # a value, so nothing will be printed here. But, if you have something -%]
1240 [% # in TT that does return a value and you don't want it printed, you -%]
1241 [% # 1) assign it to a bogus value, or -%]
1242 [% # 2) use the CALL keyword to call it and discard the return value. -%]
1243 [% tt_authors = [ ];
1244 tt_authors.push(author.last_name) FOREACH author = book.authors %]
1245 [% # Now use a TT 'virtual method' to display the author count in parens -%]
1246 [% # Note the use of the TT filter "| html" to escape dangerous characters -%]
1247 ([% tt_authors.size | html %])
1248 [% # Use another TT vmethod to join & print the names & comma separators -%]
1249 [% tt_authors.join(', ') | html %]
1253 B<IMPORTANT NOTE:> Again, you should keep as much "logic code" as
1254 possible out of your views. This kind of logic belongs in your model
1255 (the same goes for controllers -- keep them as "thin" as possible and
1256 push all of the "complicated code" out to your model objects). Avoid
1257 code like you see in the previous example -- we are only using it here
1258 to show some extra features in TT until we get to the more advanced
1259 model features we will see in Chapter 4 (see
1260 L<Catalyst::Manual::Tutorial::04_BasicCRUD/EXPLORING THE POWER OF DBIC>).
1262 Then hit "Reload" in your browser (note that you don't need to reload
1263 the development server or use the C<-r> option when updating TT
1264 templates) and you should now see the number of authors each book has
1265 along with a comma-separated list of the authors' last names. (If you
1266 didn't leave the development server running from the previous step,
1267 you will obviously need to start it before you can refresh your
1270 If you are still running the development server with C<DBIC_TRACE>
1271 enabled, you should also now see five more C<SELECT> statements in the
1272 debug output (one for each book as the authors are being retrieved by
1275 SELECT me.id, me.title, me.rating FROM book me:
1276 SELECT author.id, author.first_name, author.last_name FROM book_author me
1277 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '1'
1278 SELECT author.id, author.first_name, author.last_name FROM book_author me
1279 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '2'
1280 SELECT author.id, author.first_name, author.last_name FROM book_author me
1281 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '3'
1282 SELECT author.id, author.first_name, author.last_name FROM book_author me
1283 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '4'
1284 SELECT author.id, author.first_name, author.last_name FROM book_author me
1285 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '5'
1287 Also note in C<root/src/books/list.tt2> that we are using "| html", a
1288 type of TT filter, to escape characters such as E<lt> and E<gt> to <
1289 and > and avoid various types of dangerous hacks against your
1290 application. In a real application, you would probably want to put
1291 "| html" at the end of every field where a user has control over the
1292 information that can appear in that field (and can therefore inject
1293 markup or code if you don't "neutralize" those fields). In addition to
1294 "| html", Template Toolkit has a variety of other useful filters that
1295 can found in the documentation for
1296 L<Template::Filters|Template::Filters>.
1299 =head1 RUNNING THE APPLICATION FROM THE COMMAND LINE
1301 In some situations, it can be useful to run your application and
1302 display a page without using a browser. Catalyst lets you do this
1303 using the C<scripts/myapp_test.pl> script. Just supply the URL you
1304 wish to display and it will run that request through the normal
1305 controller dispatch logic and use the appropriate view to render the
1306 output (obviously, complex pages may dump a lot of text to your
1307 terminal window). For example, if you type:
1309 $ script/myapp_test.pl "/books/list"
1311 You should get the same text as if you visited
1312 L<http://localhost:3000/books/list> with the normal development server
1313 and asked your browser to view the page source.
1316 =head1 OPTIONAL INFORMATION
1318 B<NOTE: The rest of this chapter of the tutorial is optional. You can
1319 skip to Chapter 4, L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>,
1323 =head2 Using 'RenderView' for the Default View
1325 Once your controller logic has processed the request from a user, it
1326 forwards processing to your view in order to generate the appropriate
1327 response output. Catalyst uses
1328 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> by
1329 default to automatically perform this operation. If you look in
1330 C<lib/MyApp/Controller/Root.pm>, you should see the empty
1331 definition for the C<sub end> method:
1333 sub end : ActionClass('RenderView') {}
1335 The following bullet points provide a quick overview of the
1336 C<RenderView> process:
1342 C<Root.pm> is designed to hold application-wide logic.
1346 At the end of a given user request, Catalyst will call the most specific
1347 C<end> method that's appropriate. For example, if the controller for a
1348 request has an C<end> method defined, it will be called. However, if
1349 the controller does not define a controller-specific C<end> method, the
1350 "global" C<end> method in C<Root.pm> will be called.
1354 Because the definition includes an C<ActionClass> attribute, the
1355 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> logic
1356 will be executed B<after> any code inside the definition of C<sub end>
1357 is run. See L<Catalyst::Manual::Actions|Catalyst::Manual::Actions>
1358 for more information on C<ActionClass>.
1362 Because C<sub end> is empty, this effectively just runs the default
1363 logic in C<RenderView>. However, you can easily extend the
1364 C<RenderView> logic by adding your own code inside the empty method body
1365 (C<{}>) created by the Catalyst Helpers when we first ran the
1366 C<catalyst.pl> to initialize our application. See
1367 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> for more
1368 detailed information on how to extend C<RenderView> in C<sub end>.
1373 =head2 RenderView's "dump_info" Feature
1375 One of the nice features of C<RenderView> is that it automatically
1376 allows you to add C<dump_info=1> to the end of any URL for your
1377 application and it will force the display of the "exception dump"
1378 screen to the client browser. You can try this out by starting the
1379 development server as before and then point your browser to this URL:
1381 http://localhost:3000/books/list?dump_info=1
1383 You should get a page with the following message at the top:
1385 Caught exception in MyApp::Controller::Root->end "Forced debug -
1386 Scrubbed output at /usr/share/perl5/Catalyst/Action/RenderView.pm line 46."
1388 Along with a summary of your application's state at the end of the
1389 processing for that request. The "Stash" section should show a
1390 summarized version of the DBIC book model objects. If desired, you
1391 can adjust the summarization logic (called "scrubbing" logic) -- see
1392 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> for
1395 Note that you shouldn't need to worry about "normal clients" using
1396 this technique to "reverse engineer" your application -- C<RenderView>
1397 only supports the C<dump_info=1> feature when your application is
1398 running in C<-Debug> mode (something you won't do once you have your
1399 application deployed in production).
1402 =head2 Using The Default Template Name
1404 By default, C<Catalyst::View::TT> will look for a template that uses the
1405 same name as your controller action, allowing you to save the step of
1406 manually specifying the template name in each action. For example, this
1407 would allow us to remove the
1408 C<$c-E<gt>stash-E<gt>{template} = 'books/list.tt2';> line of our
1409 C<list> action in the Books controller. Open
1410 C<lib/MyApp/Controller/Books.pm> in your editor and comment out this line
1411 to match the following (only the C<$c-E<gt>stash-E<gt>{template}> line
1416 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
1421 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
1422 # 'Context' that's used to 'glue together' the various components
1423 # that make up the application
1424 my ($self, $c) = @_;
1426 # Retrieve all of the book records as book model objects and store in the
1427 # stash where they can be accessed by the TT template
1428 $c->stash->{books} = [$c->model('DB::Book')->all];
1430 # Set the TT template to use. You will almost always want to do this
1431 # in your action methods (actions methods respond to user input in
1432 # your controllers).
1433 #$c->stash->{template} = 'books/list.tt2';
1437 You should now be able to restart the development server as per the
1438 previous section and access the L<http://localhost:3000/books/list>
1441 B<NOTE:> Please note that if you use the default template technique,
1442 you will B<not> be able to use either the C<$c-E<gt>forward> or
1443 the C<$c-E<gt>detach> mechanisms (these are discussed in Chapter 2 and
1444 Chapter 9 of the Tutorial).
1446 B<IMPORTANT:> Make sure that you do NOT skip the following section
1447 before continuing to the next chapter 4 Basic CRUD.
1450 =head2 Return To A Manually Specified Template
1452 In order to be able to use C<$c-E<gt>forward> and C<$c-E<gt>detach>
1453 later in the tutorial, you should remove the comment from the
1454 statement in C<sub list> in C<lib/MyApp/Controller/Books.pm>:
1456 $c->stash->{template} = 'books/list.tt2';
1458 Then delete the C<TEMPLATE_EXTENSION> line in
1459 C<lib/MyApp/View/TT.pm>.
1461 You should then be able to restart the development server and
1462 access L<http://localhost:3000/books/list> in the same manner as
1463 with earlier sections.
1468 Kennedy Clark, C<hkclark@gmail.com>
1470 Please report any errors, issues or suggestions to the author. The
1471 most recent version of the Catalyst Tutorial can be found at
1472 L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
1474 Copyright 2006-2008, Kennedy Clark, under Creative Commons License
1475 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).