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:
203 use Catalyst qw/-Debug
207 Then replace it with:
218 B<Note:> Recent versions of C<Catalyst::Devel> have used a variety of
219 techniques to load these plugins/flags. For example, you might see
222 __PACKAGE__->setup(qw/-Debug ConfigLoader Static::Simple/);
224 Don't let these variations confuse you -- they all accomplish the same
227 This tells Catalyst to start using one new plugin,
228 L<Catalyst::Plugin::StackTrace|Catalyst::Plugin::StackTrace>, to add a
229 stack trace to the standard Catalyst "debug screen" (the screen
230 Catalyst sends to your browser when an error occurs). Be aware that
231 L<StackTrace|Catalyst::Plugin::StackTrace> output appears in your
232 browser, not in the console window from which you're running your
233 application, which is where logging output usually goes.
235 Make sure when adding new plugins you also include them as a new
236 dependancy within the Makefile.PL file. For example, after adding
237 the StackTrace plugin the Makefile.PL should include the following
240 requires 'Catalyst::Plugin::StackTrace';
249 C<__PACKAGE__> is just a shorthand way of referencing the name of the
250 package where it is used. Therefore, in C<MyApp.pm>, C<__PACKAGE__>
251 is equivalent to C<MyApp>.
255 You will want to disable L<StackTrace|Catalyst::Plugin::StackTrace>
256 before you put your application into production, but it can be helpful
261 When specifying plugins, you can omit C<Catalyst::Plugin::> from the
262 name. Additionally, you can spread the plugin names across multiple
263 lines as shown here or place them all on one line.
268 =head1 CREATE A CATALYST CONTROLLER
270 As discussed earlier, controllers are where you write methods that
271 interact with user input. Typically, controller methods respond to
272 C<GET> and C<POST> requests from the user's web browser.
274 Use the Catalyst C<create> script to add a controller for book-related
277 $ script/myapp_create.pl controller Books
278 exists "/home/me/MyApp/script/../lib/MyApp/Controller"
279 exists "/home/me/MyApp/script/../t"
280 created "/home/me/MyApp/script/../lib/MyApp/Controller/Books.pm"
281 created "/home/me/MyApp/script/../t/controller_Books.t"
283 Then edit C<lib/MyApp/Controller/Books.pm> (as discussed in Chapter 2 of
284 the Tutorial, Catalyst has a separate directory under C<lib/MyApp> for
285 each of the three parts of MVC: C<Model>, C<View>, and C<Controller>)
286 and add the following method to the controller:
290 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
295 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
296 # 'Context' that's used to 'glue together' the various components
297 # that make up the application
300 # Retrieve all of the book records as book model objects and store in the
301 # stash where they can be accessed by the TT template
302 # $c->stash->{books} = [$c->model('DB::Book')->all];
303 # But, for now, use this code until we create the model later
304 $c->stash->{books} = '';
306 # Set the TT template to use. You will almost always want to do this
307 # in your action methods (action methods respond to user input in
309 $c->stash->{template} = 'books/list.tt2';
312 B<TIP>: See Appendix 1 for tips on removing the leading spaces when
313 cutting and pasting example code from POD-based documents.
315 Programmers experienced with object-oriented Perl should recognize
316 C<$self> as a reference to the object where this method was called.
317 On the other hand, C<$c> will be new to many Perl programmers who have
318 not used Catalyst before (it's sometimes written as C<$context>). The
319 Context object is automatically passed to all Catalyst components. It
320 is used to pass information between components and provide access to
321 Catalyst and plugin functionality.
323 Catalyst actions are regular Perl methods, but they make use of
324 attributes (the "C<: Local>" next to the "C<sub list>" in the code
325 above) to provide additional information to the Catalyst dispatcher
326 logic (note that the space between the colon and the attribute name is
327 optional; you will see attributes written both ways). Most Catalyst
328 Controllers use one of five action types:
334 B<:Private> -- Use C<:Private> for methods that you want to make into
335 an action, but you do not want Catalyst to directly expose the method
336 to your users. Catalyst will not map C<:Private> methods to a URI.
337 Use them for various sorts of "special" methods (the C<begin>,
338 C<auto>, etc. discussed below) or for methods you want to be able to
339 C<forward> or C<detach> to. (If the method is a plain old "helper
340 method" that you don't want to be an action at all, then just define
341 the method without any attribute -- you can call it in your code, but
342 the Catalyst dispatcher will ignore it.)
344 There are five types of "special" build-in C<:Private> actions:
345 C<begin>, C<end>, C<default>, C<index>, and C<auto>.
351 With C<begin>, C<end>, C<default>, C<index> private actions, only the
352 most specific action of each type will be called. For example, if you
353 define a C<begin> action in your controller it will I<override> a
354 C<begin> action in your application/root controller -- I<only> the
355 action in your controller will be called.
359 Unlike the other actions where only a single method is called for each
360 request, I<every> auto action along the chain of namespaces will be
361 called. Each C<auto> action will be called I<from the application/root
362 controller down through the most specific class>.
368 B<:Path> -- C<:Path> actions let you map a method to an explicit URI
369 path. For example, "C<:Path('list')>" in
370 C<lib/MyApp/Controller/Books.pm> would match on the URL
371 C<http://localhost:3000/books/list>, but "C<:Path('/list')>" would
372 match on C<http://localhost:3000/list> (because of the leading slash).
373 You can use C<:Args()> to specify how many arguments an action should
374 accept. See L<Catalyst::Manual::Intro/Action_types> for more
375 information and examples.
379 B<:Local> -- C<:Local> is merely a shorthand for
380 "C<:Path('_name_of_method_')>". For example, these are equivalent:
381 "C<sub create_book :Local {...}>" and
382 "C<sub create_book :Path('create_book') {...}>".
386 B<:Global> -- C<:Global> is merely a shorthand for
387 "C<:Path('/_name_of_method_')>". For example, these are equivalent:
388 "C<sub create_book :Global {...}>" and
389 "C<sub create_book :Path('/create_book') {...}>".
393 B<:Chained> -- Newer Catalyst applications tend to use the Chained
394 dispatch form of action types because of its power and flexibility.
395 It allows a series of controller methods to be automatically dispatched
396 to service a single user request. See
397 L<Catalyst::Manual::Tutorial::04_BasicCRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
398 and L<Catalyst::DispatchType::Chained|Catalyst::DispatchType::Chained>
399 for more information on chained actions.
403 You should refer to L<Catalyst::Manual::Intro/Action_types> for
404 additional information and for coverage of some lesser-used action
405 types not discussed here (C<Regex> and C<LocalRegex>).
408 =head1 CATALYST VIEWS
410 As mentioned in Chapter 2 of the tutorial, views are where you render
411 output, typically for display in the user's web browser (but also
412 possibly using into output-generation systems, such as PDF or JSON).
413 The code in C<lib/MyApp/View> selects the I<type> of view to use, with
414 the actual rendering template found in the C<root> directory. As with
415 virtually every aspect of Catalyst, options abound when it comes to the
416 specific view technology you adopt inside your application. However,
417 most Catalyst applications use the Template Toolkit, known as TT (for
418 more information on TT, see L<http://www.template-toolkit.org>). Other
419 somewhat popular view technologies include Mason
420 (L<http://www.masonhq.com> and L<http://www.masonbook.com>) and
421 L<HTML::Template> (L<http://html-template.sourceforge.net>).
424 =head2 Create a Catalyst View
426 When using TT for the Catalyst view, the main helper script
427 is L<Catalyst::Helper::View::TT|Catalyst::Helper::View::TT>.
428 You may also come across references to
429 L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite>,
430 but its use is now deprecated.
432 Enter the following command to enable the C<TT> style of view
433 rendering for this tutorial:
435 $ script/myapp_create.pl view TT TT
436 exists "/home/me/MyApp/script/../lib/MyApp/View"
437 exists "/home/me/MyApp/script/../t"
438 created "/home/me/MyApp/script/../lib/MyApp/View/TT.pm"
439 created "/home/me/MyApp/script/../t/view_TT.t"
441 This simply creates a view called C<TT> (the second 'TT' argument) in
442 a file called C<TT.pm> (the first 'TT' argument). It is now up to you
443 to decide how you want to structure your view layout. For the
444 tutorial, we will start with a very simple TT template to initially
445 demonstrate the concepts, but quickly migrate to a more typical
446 "wrapper page" type of configuration (where the "wrapper" controls the
447 overall "look and feel" of your site from a single file or set of
450 Edit C<lib/MyApp/View/TT.pm> and you should see that the default
451 contents contains something similar to the following:
453 __PACKAGE__->config(TEMPLATE_EXTENSION => '.tt');
455 And update it to match:
458 # Change default TT extension
459 TEMPLATE_EXTENSION => '.tt2',
460 # Set the location for TT files
462 MyApp->path_to( 'root', 'src' ),
466 B<NOTE:> Make sure to add a comma after '.tt2' outside the single
469 This changes the default extension for Template Toolkit from '.tt' to
470 '.tt2' and changes the base directory for your template files from
471 C<root> to C<root/src>. Stick with these conventions for the
472 tutorial, but feel free to use whatever options you desire in your
473 applications (as with most things Perl, there's more than one way to
476 B<Note:> We will use C<root/src> as the base directory for our
477 template files, with a full naming convention of
478 C<root/src/_controller_name_/_action_name_.tt2>. Another popular option is to
479 use C<root/> as the base (with a full filename pattern of
480 C<root/_controller_name_/_action_name_.tt2>).
483 =head2 Create a TT Template Page
485 First create a directory for book-related TT templates:
487 $ mkdir -p root/src/books
489 Then create C<root/src/books/list.tt2> in your editor and enter:
491 [% # This is a TT comment. The '-' at the end "chomps" the newline. You won't -%]
492 [% # see this "chomping" in your browser because HTML ignores blank lines, but -%]
493 [% # it WILL eliminate a blank line if you view the HTML source. It's purely -%]
494 [%- # optional, but both the beginning and the ending TT tags support chomping. -%]
496 [% # Provide a title -%]
497 [% META title = 'Book List' -%]
500 <tr><th>Title</th><th>Rating</th><th>Author(s)</th></tr>
501 [% # Display each book in a table row %]
502 [% FOREACH book IN books -%]
504 <td>[% book.title %]</td>
505 <td>[% book.rating %]</td>
511 As indicated by the inline comments above, the C<META title> line uses
512 TT's META feature to provide a title to the "wrapper" that we will
513 create later. Meanwhile, the C<FOREACH> loop iterates through each
514 C<book> model object and prints the C<title> and C<rating> fields.
516 The C<[%> and C<%]> tags are used to delimit Template Toolkit code. TT
517 supports a wide variety of directives for "calling" other files,
518 looping, conditional logic, etc. In general, TT simplifies the usual
519 range of Perl operators down to the single dot (".") operator. This
520 applies to operations as diverse as method calls, hash lookups, and list
522 L<http://search.cpan.org/perldoc?Template::Manual::Variables> for
523 details and examples). In addition to the usual L<Template> module Pod
524 documentation, you can access the TT manual at
525 L<http://search.cpan.org/perldoc?Template::Manual>.
527 B<TIP:> While you can build all sorts of complex logic into your TT
528 templates, you should in general keep the "code" part of your
529 templates as simple as possible. If you need more complex logic,
530 create helper methods in your model that abstract out a set of code
531 into a single call from your TT template. (Note that the same is true
532 of your controller logic as well -- complex sections of code in your
533 controllers should often be pulled out and placed into your model
534 objects.) In Chapter 4 of the tutorial we will explore some extremely
535 helpful and powerful features of L<DBIx::Class> that allow you to pull
536 code out of your views and controllers and place it where it
537 rightfully belongs in a model class.
540 =head2 Test Run The Application
542 To test your work so far, first start the development server:
544 $ script/myapp_server.pl
546 Then point your browser to L<http://localhost:3000> and you should
547 still get the Catalyst welcome page. Next, change the URL in your
548 browser to L<http://localhost:3000/books/list>. If you have
549 everything working so far, you should see a web page that displays
550 nothing other than our column headers for "Title", "Rating", and
551 "Author(s)" -- we will not see any books until we get the database and
554 If you run into problems getting your application to run correctly, it
555 might be helpful to refer to some of the debugging techniques covered in
556 the L<Debugging|Catalyst::Manual::Tutorial::07_Debugging> chapter of the
560 =head1 CREATE A SQLITE DATABASE
562 In this step, we make a text file with the required SQL commands to
563 create a database table and load some sample data. We will use SQLite,
564 a popular database that is lightweight and easy to use. Open
565 C<myapp01.sql> in your editor and enter:
568 -- Create a very simple database to hold book and author information
571 id INTEGER PRIMARY KEY,
575 -- 'book_author' is a many-to-many join table between books & authors
576 CREATE TABLE book_author (
579 PRIMARY KEY (book_id, author_id)
581 CREATE TABLE author (
582 id INTEGER PRIMARY KEY,
587 --- Load some sample data
589 INSERT INTO book VALUES (1, 'CCSP SNRS Exam Certification Guide', 5);
590 INSERT INTO book VALUES (2, 'TCP/IP Illustrated, Volume 1', 5);
591 INSERT INTO book VALUES (3, 'Internetworking with TCP/IP Vol.1', 4);
592 INSERT INTO book VALUES (4, 'Perl Cookbook', 5);
593 INSERT INTO book VALUES (5, 'Designing with Web Standards', 5);
594 INSERT INTO author VALUES (1, 'Greg', 'Bastien');
595 INSERT INTO author VALUES (2, 'Sara', 'Nasseh');
596 INSERT INTO author VALUES (3, 'Christian', 'Degu');
597 INSERT INTO author VALUES (4, 'Richard', 'Stevens');
598 INSERT INTO author VALUES (5, 'Douglas', 'Comer');
599 INSERT INTO author VALUES (6, 'Tom', 'Christiansen');
600 INSERT INTO author VALUES (7, 'Nathan', 'Torkington');
601 INSERT INTO author VALUES (8, 'Jeffrey', 'Zeldman');
602 INSERT INTO book_author VALUES (1, 1);
603 INSERT INTO book_author VALUES (1, 2);
604 INSERT INTO book_author VALUES (1, 3);
605 INSERT INTO book_author VALUES (2, 4);
606 INSERT INTO book_author VALUES (3, 5);
607 INSERT INTO book_author VALUES (4, 6);
608 INSERT INTO book_author VALUES (4, 7);
609 INSERT INTO book_author VALUES (5, 8);
611 Then use the following command to build a C<myapp.db> SQLite database:
613 $ sqlite3 myapp.db < myapp01.sql
615 If you need to create the database more than once, you probably want to
616 issue the C<rm myapp.db> command to delete the database before you use
617 the C<sqlite3 myapp.db E<lt> myapp01.sql> command.
619 Once the C<myapp.db> database file has been created and initialized, you
620 can use the SQLite command line environment to do a quick dump of the
625 Enter ".help" for instructions
626 sqlite> select * from book;
627 1|CCSP SNRS Exam Certification Guide|5
628 2|TCP/IP Illustrated, Volume 1|5
629 3|Internetworking with TCP/IP Vol.1|4
631 5|Designing with Web Standards|5
637 $ sqlite3 myapp.db "select * from book"
638 1|CCSP SNRS Exam Certification Guide|5
639 2|TCP/IP Illustrated, Volume 1|5
640 3|Internetworking with TCP/IP Vol.1|4
642 5|Designing with Web Standards|5
644 As with most other SQL tools, if you are using the full "interactive"
645 environment you need to terminate your SQL commands with a ";" (it's not
646 required if you do a single SQL statement on the command line). Use
647 ".q" to exit from SQLite from the SQLite interactive mode and return to
648 your OS command prompt.
650 Please note that here we have chosen to use 'singular' table names. This
651 is because the default inflection code for L<DBIx::Class::Schema::Loader>
652 does NOT handle plurals. There has been much philosophical discussion
653 on whether table names should be plural or singular. There is no one
654 correct answer, as long as one makes a choice and remains consistent
655 with it. If you prefer plural table names (e.g. they are easier and
656 more natural to read) then you will need to pass it an inflect_map
657 option. See L<DBIx::Class::Schema::Loader> for more information.
659 For using other databases, such as PostgreSQL or MySQL, see
660 L<Appendix 2|Catalyst::Manual::Tutorial::10_Appendices>.
663 =head1 DATABASE ACCESS WITH DBIx::Class
665 Catalyst can be used with virtually any form of datastore available
666 via Perl. For example, L<Catalyst::Model::DBI|Catalyst::Model::DBI>
667 can be used to access databases through the traditional Perl L<DBI>
668 interface or you can use a model to access files of any type on the
669 filesystem. However, most Catalyst applications use some form of
670 object-relational mapping (ORM) technology to create objects
671 associated with tables in a relational database. Matt Trout's
672 L<DBIx::Class|DBIx::Class> (abbreviated as "DBIC") has rapidly emerged
673 as the Perl-based ORM technology of choice. Most new Catalyst
674 applications rely on DBIx::Class, as will this tutorial.
676 Although DBIx::Class has included support for a C<create=dynamic> mode
677 to automatically read the database structure every time the
678 application starts, it's use is no longer recommended. While it can
679 make for "flashy" demos, the use of the C<create=static> mode we use
680 below can be implemented just as quickly and provides many advantages
681 (such as the ability to add your own methods to the overall DBIC
682 framework, a technique that we see in Chapter 4).
685 =head2 Make Sure You Have a Recent Version of the DBIx::Class Model
687 First, let's be sure we have a recent version of the DBIC helper,
688 L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema>, by
689 running this command:
691 $ perl -MCatalyst::Model::DBIC::Schema -e \
692 'print "$Catalyst::Model::DBIC::Schema::VERSION\n"'
695 Please note the '\' above. Depending on your environment, you might
696 be able to cut and paste the text as shown or need to remove the '\'
697 character to that the command is all on a single line.
699 You should have version 0.31 or greater if you are following along
700 with Debian 5. In other environments, you may need to run this
701 command to install it directly from CPAN:
703 $ sudo cpan Catalyst::Model::DBIC::Schema
705 And re-run the version print command to verify that you are now at
709 =head2 Create Static DBIx::Class Schema Files
711 Before you continue, make sure your C<myapp.db> database file is in
712 the application's topmost directory. Now use the model helper with
713 the C<create=static> option to read the database with
714 L<DBIx::Class::Schema::Loader|DBIx::Class::Schema::Loader> and
715 automatically build the required files for us:
717 $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
718 create=static dbi:SQLite:myapp.db
719 exists "/home/me/MyApp/script/../lib/MyApp/Model"
720 exists "/home/me/MyApp/script/../t"
721 Dumping manual schema for MyApp::Schema to directory /home/me/MyApp/script/../lib ...
722 Schema dump completed.
723 created "/home/me/MyApp/script/../lib/MyApp/Model/DB.pm"
724 created "/home/me/MyApp/script/../t/model_DB.t"
726 Please note the '\' above. Depending on your environment, you might
727 be able to cut and paste the text as shown or need to remove the '\'
728 character to that the command is all on a single line.
730 The C<script/myapp_create.pl> command breaks down like this:
736 C<DB> is the name of the model class to be created by the helper in
741 C<DBIC::Schema> is the type of the model to create.
745 C<MyApp::Schema> is the name of the DBIC schema file written to
746 C<lib/MyApp/Schema.pm>.
750 C<create=static> causes
751 L<DBIx::Class::Schema::Loader|DBIx::Class::Schema::Loader> to
752 load the schema as it runs and then write that information out
757 And finally, C<dbi:SQLite:myapp.db> is the standard DBI connect string
762 If you look in the C<lib/MyApp/Schema.pm> file, you will find that it
763 only contains a call to the C<load_namespaces> method. You will also
764 find that C<lib/MyApp> contains a C<Schema> subdirectory, which then
765 has a subdirectory called "Result". This "Result" subdirectory then
766 has files named according to each of the tables in our simple database
767 (C<Author.pm>, C<BookAuthor.pm>, and C<Book.pm>). These three
768 files are called "Result Classes" in DBIx::Class nomenclature. Although the
769 Result Class files are named after tables in our database, the classes
770 correspond to the I<row-level data> that is returned by DBIC (more on
771 this later, especially in
772 L<Catalyst::Manual::Tutorial::04_BasicCRUD/EXPLORING THE POWER OF DBIC>).
774 The idea with the Result Source files created under
775 C<lib/MyApp/Schema/Result> by the C<create=static> option is to only
776 edit the files below the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
777 warning. If you place all of your changes below that point in the
778 file, you can regenerate the automatically created information at the
779 top of each file should your database structure get updated.
781 Also note the "flow" of the model information across the various files
782 and directories. Catalyst will initially load the model from
783 C<lib/MyApp/Model/DB.pm>. This file contains a reference to
784 C<lib/MyApp/Schema.pm>, so that file is loaded next. Finally, the
785 call to C<load_namespaces> in C<Schema.pm> will load each of the
786 "Result Class" files from the C<lib/MyApp/Schema/Result> subdirectory.
787 The final outcome is that Catalyst will dynamically create three
788 table-specific Catalyst models every time the application starts (you
789 can see these three model files listed in the debug output generated
790 when you launch the application).
792 B<NOTE:> Older versions of
793 L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema> use the
794 deprecated DBIx::Class C<load_classes> technique instead of the newer
795 C<load_namspaces>. For new applications, please try to use
796 C<load_namespaces> since it more easily supports a very useful DBIC
797 technique called "ResultSet Classes." If you need to convert an
798 existing application from "load_classes" to "load_namespaces," you can
799 use this process to automate the migration (but first make sure you
800 have v0.23 C<Catalyst::Model::DBIC::Schema> as discussed above):
802 $ # First delete the existing schema file to disable "compatibility" mode
803 $ rm lib/MyApp/Schema.pm
805 $ # Then re-run the helper to build the files for "load_namespaces"
806 $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
807 create=static dbi:SQLite:myapp.db
809 $ # Now convert the existing files over
810 $ cd lib/MyApp/Schema
811 $ perl -MIO::All -e 'for (@ARGV) { my $s < io($_); $s =~ s/.*\n\# You can replace.*?\n//s;
812 $s =~ s/'MyApp::Schema::/'MyApp::Schema::Result::/g; my $d < io("Result/$_");
813 $d =~ s/1;\n?//; "$d$s" > io("Result/$_"); }' *.pm
816 $ # And finally delete the old files
817 $ rm lib/MyApp/Schema/*.pm
819 The "C<perl -MIO::ALL ...>" script will copy all the customized
820 relationship (and other) information below "C<# DO NOT MODIFY>" line
821 from the old files in C<lib/MyApp/Schema> to the new files in
822 C<lib/MyApp/Schema/Result> (we will be starting to add some
823 "customized relationship information in the section below).
826 =head1 ENABLE THE MODEL IN THE CONTROLLER
828 Open C<lib/MyApp/Controller/Books.pm> and un-comment the model code we
829 left disabled earlier so that your version matches the following (un-
830 comment the line containing C<[$c-E<gt>model('DB::Book')-E<gt>all]>
831 and delete the next 2 lines):
835 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
840 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
841 # 'Context' that's used to 'glue together' the various components
842 # that make up the application
845 # Retrieve all of the book records as book model objects and store in the
846 # stash where they can be accessed by the TT template
847 $c->stash->{books} = [$c->model('DB::Book')->all];
849 # Set the TT template to use. You will almost always want to do this
850 # in your action methods (action methods respond to user input in
852 $c->stash->{template} = 'books/list.tt2';
855 B<TIP>: You may see the C<$c-E<gt>model('DB::Book')> un-commented
856 above written as C<$c-E<gt>model('DB')-E<gt>resultset('Book')>. The
857 two are equivalent. Either way, C<$c-E<gt>model> returns a
858 L<DBIx::Class::ResultSet|DBIx::Class::ResultSet> which handles queries
859 against the database and iterating over the set of results that is
862 We are using the C<-E<gt>all> to fetch all of the books. DBIC
863 supports a wide variety of more advanced operations to easily do
864 things like filtering and sorting the results. For example, the
865 following could be used to sort the results by descending title:
867 $c->model('DB::Book')->search({}, {order_by => 'title DESC'});
869 Some other examples are provided in
870 L<DBIx::Class::Manual::Cookbook/Complex WHERE clauses>, with
871 additional information found at L<DBIx::Class::ResultSet/search>,
872 L<DBIx::Class::Manual::FAQ/Searching>,
873 L<DBIx::Class::Manual::Intro|DBIx::Class::Manual::Intro>
874 and L<Catalyst::Model::DBIC::Schema|Catalyst::Model::DBIC::Schema>.
877 =head2 Test Run The Application
879 First, let's enable an environment variable that causes DBIx::Class to
880 dump the SQL statements used to access the database. This is a
881 helpful trick when you are trying to debug your database-oriented
884 $ export DBIC_TRACE=1
886 This assumes you are using bash as your shell -- adjust accordingly if
887 you are using a different shell (for example, under tcsh, use
888 C<setenv DBIC_TRACE 1>).
890 B<NOTE:> You can also set this in your code using
891 C<$class-E<gt>storage-E<gt>debug(1);>. See
892 L<DBIx::Class::Manual::Troubleshooting> for details (including options
893 to log to a file instead of displaying to the Catalyst development server
896 Then launch the Catalyst development server. The log output should
897 display something like:
899 $ script/myapp_server.pl
900 [debug] Debug messages enabled
901 [debug] Statistics enabled
902 [debug] Loaded plugins:
903 .----------------------------------------------------------------------------.
904 | Catalyst::Plugin::ConfigLoader 0.27 |
905 | Catalyst::Plugin::StackTrace 0.11 |
906 | Catalyst::Plugin::Static::Simple 0.25 |
907 '----------------------------------------------------------------------------'
909 [debug] Loaded dispatcher "Catalyst::Dispatcher"
910 [debug] Loaded engine "Catalyst::Engine::HTTP"
911 [debug] Found home "/home/me/MyApp"
912 [debug] Loaded Config "/home/me/MyApp/myapp.conf"
913 [debug] Loaded components:
914 .-----------------------------------------------------------------+----------.
916 +-----------------------------------------------------------------+----------+
917 | MyApp::Controller::Books | instance |
918 | MyApp::Controller::Root | instance |
919 | MyApp::Model::DB | instance |
920 | MyApp::Model::DB::Author | class |
921 | MyApp::Model::DB::Book | class |
922 | MyApp::Model::DB::BookAuthor | class |
923 | MyApp::View::TT | instance |
924 '-----------------------------------------------------------------+----------'
926 [debug] Loaded Private actions:
927 .----------------------+--------------------------------------+--------------.
928 | Private | Class | Method |
929 +----------------------+--------------------------------------+--------------+
930 | /default | MyApp::Controller::Root | default |
931 | /end | MyApp::Controller::Root | end |
932 | /index | MyApp::Controller::Root | index |
933 | /books/index | MyApp::Controller::Books | index |
934 | /books/list | MyApp::Controller::Books | list |
935 '----------------------+--------------------------------------+--------------'
937 [debug] Loaded Path actions:
938 .-------------------------------------+--------------------------------------.
940 +-------------------------------------+--------------------------------------+
943 | /books | /books/index |
944 | /books/list | /books/list |
945 '-------------------------------------+--------------------------------------'
947 [info] MyApp powered by Catalyst 5.80013
948 You can connect to your server at http://debian:3000
950 B<NOTE:> Be sure you run the C<script/myapp_server.pl> command from
951 the 'base' directory of your application, not inside the C<script>
952 directory itself or it will not be able to locate the C<myapp.db>
953 database file. You can use a fully qualified or a relative path to
954 locate the database file, but we did not specify that when we ran the
955 model helper earlier.
957 Some things you should note in the output above:
963 Catalyst::Model::DBIC::Schema dynamically created three model classes,
964 one to represent each of the three tables in our database
965 (C<MyApp::Model::DB::Author>, C<MyApp::Model::DB::BookAuthor>,
966 and C<MyApp::Model::DB::Book>).
970 The "list" action in our Books controller showed up with a path of
975 Point your browser to L<http://localhost:3000> and you should still get
976 the Catalyst welcome page.
978 Next, to view the book list, change the URL in your browser to
979 L<http://localhost:3000/books/list>. You should get a list of the five
980 books loaded by the C<myapp01.sql> script above without any formatting.
981 The rating for each book should appear on each row, but the "Author(s)"
982 column will still be blank (we will fill that in later).
984 Also notice in the output of the C<script/myapp_server.pl> that
985 DBIx::Class used the following SQL to retrieve the data:
987 SELECT me.id, me.title, me.rating FROM book me
989 because we enabled DBIC_TRACE.
991 You now have the beginnings of a simple but workable web application.
992 Continue on to future sections and we will develop the application
996 =head1 CREATE A WRAPPER FOR THE VIEW
998 When using TT, you can (and should) create a wrapper that will
999 literally wrap content around each of your templates. This is
1000 certainly useful as you have one main source for changing things that
1001 will appear across your entire site/application instead of having to
1002 edit many individual files.
1005 =head2 Configure TT.pm For The Wrapper
1007 In order to create a wrapper, you must first edit your TT view and
1008 tell it where to find your wrapper file.
1010 Edit you TT view in C<lib/MyApp/View/TT.pm> and change it to match the
1013 __PACKAGE__->config(
1014 # Change default TT extension
1015 TEMPLATE_EXTENSION => '.tt2',
1016 # Set the location for TT files
1018 MyApp->path_to( 'root', 'src' ),
1020 # Set to 1 for detailed timer stats in your HTML as comments
1022 # This is your wrapper template located in the 'root/src'
1023 WRAPPER => 'wrapper.tt2',
1027 =head2 Create the Wrapper Template File and Stylesheet
1029 Next you need to set up your wrapper template. Basically, you'll want
1030 to take the overall layout of your site and put it into this file.
1031 For the tutorial, open C<root/src/wrapper.tt2> and input the following:
1033 <?xml version="1.0" encoding="UTF-8"?>
1034 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1035 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1037 <title>[% template.title or "My Catalyst App!" %]</title>
1038 <link rel="stylesheet" href="[% c.uri_for('/static/css/main.css') %]" />
1044 [%# Your logo could go here -%]
1045 <img src="[% c.uri_for('/static/images/btn_88x31_powered.png') %]" />
1046 [%# Insert the page title -%]
1047 <h1>[% template.title or site.title %]</h1>
1050 <div id="bodyblock">
1054 <li><a href="[% c.uri_for('/books/list') %]">Home</a></li>
1055 <li><a href="[% c.uri_for('/') %]" title="Catalyst Welcome Page">Welcome</a></li>
1057 </div><!-- end menu -->
1060 [%# Status and error messages %]
1061 <span class="message">[% status_msg %]</span>
1062 <span class="error">[% error_msg %]</span>
1063 [%# This is where TT will stick all of your template's contents. -%]
1065 </div><!-- end content -->
1066 </div><!-- end bodyblock -->
1068 <div id="footer">Copyright (c) your name goes here</div>
1069 </div><!-- end outer -->
1074 Notice the status and error message sections in the code above:
1076 <span class="status">[% status_msg %]</span>
1077 <span class="error">[% error_msg %]</span>
1079 If we set either message in the Catalyst stash (e.g.,
1080 C<$c-E<gt>stash-E<gt>{status_msg} = 'Request was successful!'>) it
1081 will be displayed whenever any view used by that request is rendered.
1082 The C<message> and C<error> CSS styles can be customized to suit your
1083 needs in the C<root/static/css/main.css> file we create below.
1091 The Catalyst stash only lasts for a single HTTP request. If
1092 you need to retain information across requests you can use
1093 L<Catalyst::Plugin::Session|Catalyst::Plugin::Session> (we will use
1094 Catalyst sessions in the Authentication chapter of the tutorial).
1098 Although it is beyond the scope of this tutorial, you may wish to use
1099 a JavaScript or AJAX tool such as jQuery (L<http://www.jquery.com>) or
1100 Dojo (L<http://www.dojotoolkit.org>).
1105 =head3 Create A Basic Stylesheet
1107 First create a central location for stylesheets under the static
1110 $ mkdir root/static/css
1112 Then open the file C<root/static/css/main.css> (the file referenced in
1113 the stylesheet href link of our wrapper above) and add the following
1132 background-color: #ddd;
1138 padding: 0 0 50% 5px;
1139 font-weight: normal;
1140 background-color: #ddd;
1153 You may wish to check out a "CSS Framework" like Emastic
1154 (L<http://code.google.com/p/emastic/>) as a way to quickly
1155 provide lots of high-quality CSS functionality.
1158 =head2 Test Run The Application
1160 Restart the development server and hit "Reload" in your web browser
1161 and you should now see a formatted version of our basic book list.
1162 Although our wrapper and stylesheet are obviously very simple, you
1163 should see how it allows us to control the overall look of an entire
1164 website from two central files. To add new pages to the site, just
1165 provide a template that fills in the C<content> section of our wrapper
1166 template -- the wrapper will provide the overall feel of the page.
1169 =head2 Updating the Generated DBIx::Class Result Class Files
1171 Let's manually add some relationship information to the auto-generated
1172 Result Class files. (Note: if you are using a database other than
1173 SQLite, such as PostgreSQL, then the relationship could have been
1174 automatically placed in the Result Class files. If so, you can skip
1175 this step.) First edit C<lib/MyApp/Schema/Result/Book.pm> and add the
1176 following text below the C<# You can replace this text...> comment:
1179 # Set relationships:
1184 # 1) Name of relationship, DBIC will create accessor with this name
1185 # 2) Name of the model class referenced by this relationship
1186 # 3) Column name in *foreign* table (aka, foreign key in peer table)
1187 __PACKAGE__->has_many(book_authors => 'MyApp::Schema::Result::BookAuthor', 'book_id');
1191 # 1) Name of relationship, DBIC will create accessor with this name
1192 # 2) Name of has_many() relationship this many_to_many() is shortcut for
1193 # 3) Name of belongs_to() relationship in model class of has_many() above
1194 # You must already have the has_many() defined to use a many_to_many().
1195 __PACKAGE__->many_to_many(authors => 'book_authors', 'author');
1198 B<Note:> Be careful to put this code I<above> the C<1;> at the end of the
1199 file. As with any Perl package, we need to end the last line with
1200 a statement that evaluates to C<true>. This is customarily done with
1201 C<1;> on a line by itself.
1203 This code defines both a C<has_many> and a C<many_to_many>
1204 relationship. The C<many_to_many> relationship is optional, but it
1205 makes it easier to map a book to its collection of authors. Without
1206 it, we would have to "walk" though the C<book_author> table as in
1207 C<$book-E<gt>book_author-E<gt>first-E<gt>author-E<gt>last_name> (we
1208 will see examples on how to use DBIx::Class objects in your code soon,
1209 but note that because C<$book-E<gt>book_author> can return multiple
1210 authors, we have to use C<first> to display a single author).
1211 C<many_to_many> allows us to use the shorter
1212 C<$book-E<gt>author-E<gt>first-E<gt>last_name>. Note that you cannot
1213 define a C<many_to_many> relationship without also having the
1214 C<has_many> relationship in place.
1216 Then edit C<lib/MyApp/Schema/Result/Author.pm> and add relationship
1217 information as follows (again, be careful to put in above the C<1;> but
1218 below the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment):
1221 # Set relationships:
1226 # 1) Name of relationship, DBIC will create an accessor with this name
1227 # 2) Name of the model class referenced by this relationship
1228 # 3) Column name in *foreign* table (aka, foreign key in peer table)
1229 __PACKAGE__->has_many(book_authors => 'MyApp::Schema::Result::BookAuthor', 'author_id');
1233 # 1) Name of relationship, DBIC will create accessor with this name
1234 # 2) Name of has_many() relationship this many_to_many() is shortcut for
1235 # 3) Name of belongs_to() relationship in model class of has_many() above
1236 # You must already have the has_many() defined to use a many_to_many().
1237 __PACKAGE__->many_to_many(books => 'book_authors', 'book');
1239 Finally, do the same for the "join table,"
1240 C<lib/MyApp/Schema/Result/BookAuthor.pm>:
1243 # Set relationships:
1248 # 1) Name of relationship, DBIC will create accessor with this name
1249 # 2) Name of the model class referenced by this relationship
1250 # 3) Column name in *this* table
1251 __PACKAGE__->belongs_to(book => 'MyApp::Schema::Result::Book', 'book_id');
1255 # 1) Name of relationship, DBIC will create accessor with this name
1256 # 2) Name of the model class referenced by this relationship
1257 # 3) Column name in *this* table
1258 __PACKAGE__->belongs_to(author => 'MyApp::Schema::Result::Author', 'author_id');
1261 =head2 Run The Application
1263 Run the Catalyst development server script with the C<DBIC_TRACE> option
1264 (it might still be enabled from earlier in the tutorial, but here is an
1265 alternate way to specify the option just in case):
1267 $ DBIC_TRACE=1 script/myapp_server.pl
1269 Make sure that the application loads correctly and that you see the
1270 three dynamically created model class (one for each of the
1271 Result Classes we created).
1273 Then hit the URL L<http://localhost:3000/books/list> with your browser
1274 and be sure that the book list still displays correctly. You can leave
1275 the development server running for the next step if you wish.
1277 B<Note:> You will not see the authors yet because the view does not yet
1278 use the new relations. Read on to the next section where we update the
1279 template to do that.
1282 =head1 UPDATING THE VIEW
1284 Let's add a new column to our book list page that takes advantage of
1285 the relationship information we manually added to our schema files in
1286 the previous section. Edit C<root/src/books/list.tt2> and replace
1287 the "empty" table cell "<td></td>" with the following:
1291 [% # NOTE: See Chapter 4 for a better way to do this! -%]
1292 [% # First initialize a TT variable to hold a list. Then use a TT FOREACH -%]
1293 [% # loop in 'side effect notation' to load just the last names of the -%]
1294 [% # authors into the list. Note that the 'push' TT vmethod doesn't return -%]
1295 [% # a value, so nothing will be printed here. But, if you have something -%]
1296 [% # in TT that does return a value and you don't want it printed, you -%]
1297 [% # 1) assign it to a bogus value, or -%]
1298 [% # 2) use the CALL keyword to call it and discard the return value. -%]
1299 [% tt_authors = [ ];
1300 tt_authors.push(author.last_name) FOREACH author = book.authors %]
1301 [% # Now use a TT 'virtual method' to display the author count in parens -%]
1302 [% # Note the use of the TT filter "| html" to escape dangerous characters -%]
1303 ([% tt_authors.size | html %])
1304 [% # Use another TT vmethod to join & print the names & comma separators -%]
1305 [% tt_authors.join(', ') | html %]
1309 B<IMPORTANT NOTE:> Again, you should keep as much "logic code" as
1310 possible out of your views. This kind of logic belongs in your model
1311 (the same goes for controllers -- keep them as "thin" as possible and
1312 push all of the "complicated code" out to your model objects). Avoid
1313 code like you see in the previous example -- we are only using it here
1314 to show some extra features in TT until we get to the more advanced
1315 model features we will see in Chapter 4 (see
1316 L<Catalyst::Manual::Tutorial::04_BasicCRUD/EXPLORING THE POWER OF DBIC>).
1318 Then hit "Reload" in your browser (note that you don't need to reload
1319 the development server or use the C<-r> option when updating TT
1320 templates) and you should now see the number of authors each book has
1321 along with a comma-separated list of the authors' last names. (If you
1322 didn't leave the development server running from the previous step,
1323 you will obviously need to start it before you can refresh your
1326 If you are still running the development server with C<DBIC_TRACE>
1327 enabled, you should also now see five more C<SELECT> statements in the
1328 debug output (one for each book as the authors are being retrieved by
1331 SELECT me.id, me.title, me.rating FROM book me:
1332 SELECT author.id, author.first_name, author.last_name FROM book_author me
1333 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '1'
1334 SELECT author.id, author.first_name, author.last_name FROM book_author me
1335 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '2'
1336 SELECT author.id, author.first_name, author.last_name FROM book_author me
1337 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '3'
1338 SELECT author.id, author.first_name, author.last_name FROM book_author me
1339 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '4'
1340 SELECT author.id, author.first_name, author.last_name FROM book_author me
1341 JOIN author author ON author.id = me.author_id WHERE ( me.book_id = ? ): '5'
1343 Also note in C<root/src/books/list.tt2> that we are using "| html", a
1344 type of TT filter, to escape characters such as E<lt> and E<gt> to <
1345 and > and avoid various types of dangerous hacks against your
1346 application. In a real application, you would probably want to put
1347 "| html" at the end of every field where a user has control over the
1348 information that can appear in that field (and can therefore inject
1349 markup or code if you don't "neutralize" those fields). In addition to
1350 "| html", Template Toolkit has a variety of other useful filters that
1351 can found in the documentation for
1352 L<Template::Filters|Template::Filters>.
1355 =head1 RUNNING THE APPLICATION FROM THE COMMAND LINE
1357 In some situations, it can be useful to run your application and
1358 display a page without using a browser. Catalyst lets you do this
1359 using the C<scripts/myapp_test.pl> script. Just supply the URL you
1360 wish to display and it will run that request through the normal
1361 controller dispatch logic and use the appropriate view to render the
1362 output (obviously, complex pages may dump a lot of text to your
1363 terminal window). For example, if you type:
1365 $ script/myapp_test.pl "/books/list"
1367 You should get the same text as if you visited
1368 L<http://localhost:3000/books/list> with the normal development server
1369 and asked your browser to view the page source.
1372 =head1 OPTIONAL INFORMATION
1374 B<NOTE: The rest of this chapter of the tutorial is optional. You can
1375 skip to Chapter 4, L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>,
1379 =head2 Using 'RenderView' for the Default View
1381 Once your controller logic has processed the request from a user, it
1382 forwards processing to your view in order to generate the appropriate
1383 response output. Catalyst uses
1384 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> by
1385 default to automatically perform this operation. If you look in
1386 C<lib/MyApp/Controller/Root.pm>, you should see the empty
1387 definition for the C<sub end> method:
1389 sub end : ActionClass('RenderView') {}
1391 The following bullet points provide a quick overview of the
1392 C<RenderView> process:
1398 C<Root.pm> is designed to hold application-wide logic.
1402 At the end of a given user request, Catalyst will call the most specific
1403 C<end> method that's appropriate. For example, if the controller for a
1404 request has an C<end> method defined, it will be called. However, if
1405 the controller does not define a controller-specific C<end> method, the
1406 "global" C<end> method in C<Root.pm> will be called.
1410 Because the definition includes an C<ActionClass> attribute, the
1411 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> logic
1412 will be executed B<after> any code inside the definition of C<sub end>
1413 is run. See L<Catalyst::Manual::Actions|Catalyst::Manual::Actions>
1414 for more information on C<ActionClass>.
1418 Because C<sub end> is empty, this effectively just runs the default
1419 logic in C<RenderView>. However, you can easily extend the
1420 C<RenderView> logic by adding your own code inside the empty method body
1421 (C<{}>) created by the Catalyst Helpers when we first ran the
1422 C<catalyst.pl> to initialize our application. See
1423 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> for more
1424 detailed information on how to extend C<RenderView> in C<sub end>.
1429 =head2 RenderView's "dump_info" Feature
1431 One of the nice features of C<RenderView> is that it automatically
1432 allows you to add C<dump_info=1> to the end of any URL for your
1433 application and it will force the display of the "exception dump"
1434 screen to the client browser. You can try this out by starting the
1435 development server as before and then point your browser to this URL:
1437 http://localhost:3000/books/list?dump_info=1
1439 You should get a page with the following message at the top:
1441 Caught exception in MyApp::Controller::Root->end "Forced debug -
1442 Scrubbed output at /usr/share/perl5/Catalyst/Action/RenderView.pm line 46."
1444 Along with a summary of your application's state at the end of the
1445 processing for that request. The "Stash" section should show a
1446 summarized version of the DBIC book model objects. If desired, you
1447 can adjust the summarization logic (called "scrubbing" logic) -- see
1448 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView> for
1451 Note that you shouldn't need to worry about "normal clients" using
1452 this technique to "reverse engineer" your application -- C<RenderView>
1453 only supports the C<dump_info=1> feature when your application is
1454 running in C<-Debug> mode (something you won't do once you have your
1455 application deployed in production).
1458 =head2 Using The Default Template Name
1460 By default, C<Catalyst::View::TT> will look for a template that uses the
1461 same name as your controller action, allowing you to save the step of
1462 manually specifying the template name in each action. For example, this
1463 would allow us to remove the
1464 C<$c-E<gt>stash-E<gt>{template} = 'books/list.tt2';> line of our
1465 C<list> action in the Books controller. Open
1466 C<lib/MyApp/Controller/Books.pm> in your editor and comment out this line
1467 to match the following (only the C<$c-E<gt>stash-E<gt>{template}> line
1472 Fetch all book objects and pass to books/list.tt2 in stash to be displayed
1477 # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst
1478 # 'Context' that's used to 'glue together' the various components
1479 # that make up the application
1480 my ($self, $c) = @_;
1482 # Retrieve all of the book records as book model objects and store in the
1483 # stash where they can be accessed by the TT template
1484 $c->stash->{books} = [$c->model('DB::Book')->all];
1486 # Set the TT template to use. You will almost always want to do this
1487 # in your action methods (actions methods respond to user input in
1488 # your controllers).
1489 #$c->stash->{template} = 'books/list.tt2';
1493 You should now be able to restart the development server as per the
1494 previous section and access the L<http://localhost:3000/books/list>
1497 B<NOTE:> Please note that if you use the default template technique,
1498 you will B<not> be able to use either the C<$c-E<gt>forward> or
1499 the C<$c-E<gt>detach> mechanisms (these are discussed in Chapter 2 and
1500 Chapter 9 of the Tutorial).
1502 B<IMPORTANT:> Make sure that you do NOT skip the following section
1503 before continuing to the next chapter 4 Basic CRUD.
1506 =head2 Return To A Manually Specified Template
1508 In order to be able to use C<$c-E<gt>forward> and C<$c-E<gt>detach>
1509 later in the tutorial, you should remove the comment from the
1510 statement in C<sub list> in C<lib/MyApp/Controller/Books.pm>:
1512 $c->stash->{template} = 'books/list.tt2';
1514 Then delete the C<TEMPLATE_EXTENSION> line in
1515 C<lib/MyApp/View/TT.pm>.
1517 You should then be able to restart the development server and
1518 access L<http://localhost:3000/books/list> in the same manner as
1519 with earlier sections.
1524 Kennedy Clark, C<hkclark@gmail.com>
1526 Please report any errors, issues or suggestions to the author. The
1527 most recent version of the Catalyst Tutorial can be found at
1528 L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
1530 Copyright 2006-2008, Kennedy Clark, under Creative Commons License
1531 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).