3 Catalyst::Manual::Intro - Introduction to Catalyst
7 This is a brief overview of why and how to use Catalyst. It explains how Catalyst works and shows how to quickly get a simple application up and running.
9 =head2 What is Catalyst?
11 Catalyst is an elegant web application framework, extremely flexible yet extremely simple. It's similar to Ruby on Rails, Spring (Java) and L<Maypole>, upon which it was originally based.
15 Catalyst follows the Model-View-Controller (MVC) design pattern, allowing you to easily separate concerns, like content, presentation and flow control, into separate modules. This separation allows you to modify code that handles one concern without affecting code that handles the others. Catalyst promotes re-use of existing Perl modules that already handle common web application concerns well.
17 Here's how the M, V and C map to those concerns, with examples of well-known Perl modules you may want to use for each.
23 Access and modify content (data). L<Class::DBI>, L<Plucene>, L<Net::LDAP>...
27 Present content to the user. L<Template Toolkit|Template>, L<Mason|HTML::Mason>...
31 Control the whole request phase, check parameters, dispatch actions, flow control. Catalyst!
35 If you're unfamiliar with MVC and design patterns, you may want to check out the original book on the subject, I<Design Patterns>, by Gamma, Helm, Johson and Vlissides, also known as the Gang of Four (GoF). You can also just google it. Many, many web application frameworks are based on MVC, including all those listed above.
39 Catalyst is much more flexible than many other frameworks. We'll talk more about this later, but rest assured you can use your favorite perl modules with Catalyst.
43 =item * B<Multiple Models, Views and Controllers>
45 To build a Catalyst application, you handle each type of concern inside special modules called L</Components>. Often this code will be very simple, just calling out to Perl modules like those listed above under L</MVC>. Catalyst handles these components in a very flexible way. Use as many Models, Views and Controllers as you like, using as many different Perl modules as you like, all in the same application. Want to manipulate multiple databases, and retrieve some data via LDAP? No problem. Want to present data from the same Model using L<Template Toolkit|Template> and L<PDF::Template>? Easy.
47 =item * B<Reuseable Components>
49 Not only does Catalyst promote the re-use of already existing Perl modules, it also allows you to re-use your Catalyst components in multiple Catalyst applications.
51 =item * B<Unrestrained URL-to-Action Dispatching>
53 Catalyst allows you to dispatch any URLs to any application L<Actions>, even through regular expressions! Unlike most other frameworks, it doesn't require mod_rewrite or class and method names in URLs.
55 With Catalyst you register your actions and address them directly. For example:
58 my ( $self, $context ) = @_;
59 $context->response->output('Hello World!');
62 Now http://localhost:3000/hello prints "Hello World!".
64 =item * B<Support for CGI, mod_perl, Apache::Request>
66 Use L<Catalyst::Engine::Apache> or L<Catalyst::Engine::CGI>.
72 The best part is that Catalyst implements all this flexibility in a very simple way.
76 =item * B<Building Block Interface>
78 Components interoperate very smoothly. For example, Catalyst automatically makes a L<Context> object available to every component. Via the context, you can access the request object, share data between components, and control the flow of your application. Building a Catalyst application feels a lot like snapping together toy building blocks, and everything just works.
80 =item * B<Component Auto-Discovery>
82 No need to C<use> all of your components. Catalyst automatically finds and loads them.
84 =item * B<Pre-Built Components for Popular Modules>
86 See L<Catalyst::Model::CDBI> for L<Class::DBI>, or L<Catalyst::View::TT> for L<Template Toolkit|Template>. You can even get an instant web database front end with L<Catalyst::Model::CDBI::CRUD>.
88 =item * B<Builtin Test Framework>
90 Catalyst comes with a builtin, lightweight http server and test framework, making it easy to test applications from the command line.
92 =item * B<Helper Scripts>
94 Catalyst provides helper scripts to quickly generate running starter code for components and unit tests.
100 Here's how to install Catalyst and get a simple application up and running, using the helper scripts described above.
104 $ perl -MCPAN -e 'install Bundle::Catalyst'
110 $ script/create.pl controller My::Controller
116 Now visit these locations with your favorite browser or user agent to see Catalyst in action:
120 =item http://localhost:3000/
122 =item http://localhost:3000/my_controller/
130 Let's see how Catalyst works, by taking a closer look at the components and other parts of a Catalyst application.
132 =head3 Application Class
134 In addition to the Model, View and Controller components, there's a single class that represents your application itself. This is where you configure your application, load plugins, define application-wide actions and extend Catalyst.
139 use Catalyst qw/-Debug/;
142 name => 'My Application',
143 root => '/home/joeuser/myapp/root',
145 # You can put whatever you want in here:
146 # my_param_name => $my_param_value,
149 sub default : Private {
150 my ( $self, $context ) = @_;
151 $context->response->output('Catalyst rockz!');
156 For most applications, Catalyst requires you to define only two config parameters:
162 Name of your application.
166 Path to additional files like templates, images or other static data.
170 However, you can define as many parameters as you want for plugins or whatever you need. You can access them anywhere in your application via C<$context-E<gt>config-E<gt>{$param_name}>.
174 Catalyst automatically blesses a Context object into your application class and makes it available everywhere in your application. Use the Context to directly interact with Catalyst and glue your L<Components> together.
176 As illustrated earlier in our URL-to-Action dispatching example, the Context is always the second method parameter, behind the Component object reference or class name itself. Previously we called it C<$context> for clarity, but most Catalyst developers just call it C<$c>:
179 my ( $self, $c ) = @_;
180 $c->res->output('Hello World!');
183 The Context contains several important objects:
187 =item * L<Catalyst::Request>
192 The request object contains all kinds of request-specific information, like query parameters, cookies, uploads, headers and more.
194 $c->req->params->{foo};
195 $c->req->cookies->{sessionid};
196 $c->req->headers->content_type;
199 =item * L<Catalyst::Response>
204 The response is like the request, but contains just response-specific information.
206 $c->res->output('Hello World');
207 $c->res->status(404);
208 $c->res->redirect('http://oook.de');
210 =item * L<Catalyst::Config>
217 =item * L<Catalyst::Log>
221 $c->log->debug('Something happened');
222 $c->log->info('Something you should know');
228 $c->stash->{foo} = 'bar';
232 The last of these, the stash, is a universal hash for sharing data among application components. For an example, we return to our 'hello' action:
235 my ( $self, $c ) = @_;
236 $c->stash->{message} = 'Hello World!';
237 $c->forward('show-message');
240 show-message : Private {
241 my ( $self, $c ) = @_;
242 $c->res->output( $c->stash->{message} );
247 A Catalyst controller is defined by it's actions. An action is a sub
248 with a special attribute. You've already seen some example of actions
252 Catalyst supports several types of actions:
258 sub bar : Path('/foo/bar') { }
260 Matches only http://localhost:3000/foo/bar.
264 sub bar : Regex('^foo(\d+)/bar(\d+)$') { }
266 Matches any URL that matches the pattern in the action key, e.g. http://localhost:3000/foo23/bar42. The '' around the regexp is optional, but perltidy likes it. :)
268 If you use capturing parantheses to extract values within the matching URL (23, 42 in the above example), those values are available in the $c->req->snippets array. If you want to pass arguments at the end of your URL, you must use regex action keys. See L</URL Argument Handling> below.
275 Matches http://localhost:3000/foo. The function name is mapped
276 directly to the application base.
278 =item * B<Namespace-Prefixed>
280 package MyApp::C::My::Controller;
283 Matches http://localhost:3000/my/controller/foo.
285 This action type indicates that the matching URL must be prefixed with a modified form of the component's class (package) name. This modified class name excludes the parts that have a pre-defined meaning in Catalyst ("MyApp::C" in the above example), replaces "::" with "/" and converts the name to lower case. See L</Components> for a full explanation of the pre-defined meaning of Catalyst component class names.
289 sub foo : Private { }
291 Matches no URL, and cannot be executed by requesting a URL that corresponds to the action key. Private actions can be executed only inside a Catalyst application, by calling the C<forward> method:
295 See L</Flow Control> for a full explanation of C<forward>.
299 B<Note> After seeing these examples, you probably wonder what the point is of defining names for regex and path actions. Actually, every public
300 action is also a private one, so you have one unified way of addressing components in your forwards.
302 =head4 Builtin Private Actions
304 In response to specific application states, Catalyst will automatically call these built in private actions:
308 =item * B<default : Private>
310 Called when no other action matches.
312 =item * B<begin : Private>
314 Called at the beginning of a request, before any matching actions are called.
316 =item * B<end : Private>
320 Called at the end of a request, after all matching actions are called.
322 =head4 B<Builtin actions in controllers/autochaining>
324 Package MyApp::C::Foo;
325 sub begin : Private { }
326 sub default : Private { }
328 You can define the Builtin Private Actions within your controllers as
329 well. The actions will override the ones in lower level controllers/
332 In addition to the normal builtins, you have a special action for
333 making inheritance chains, 'auto'. These will be run after begin,
334 but before your action is processed.
338 =item for a request for /foo/foo
345 =item for a request for /foo/bar/foo
347 MyApp::C::Foo::Bar::begin
350 MyApp::C::Foo::Bar::default
351 MyApp::C::Foo::Bar::end
355 Also, if you need to break out of the chain in one of your auto
356 actions, you can return 0, if so, your action will not be processed,
357 but the end will, so for the request above, if the first auto returns
358 false, it would look like this:
362 =item for a request for /foo/bar/foo where auto returns false
364 MyApp::C::Foo::Bar::begin
366 MyApp::C::Foo::Bar::end
370 =head4 B<URL Argument Handling>
372 If you want to pass variable arguments at the end of a URL, you must use regex actions keys with '^' and '$' anchors, and the arguments must be separated with forward slashes (/) in the URL. For example, suppose you want to handle /foo/$bar/$baz, where $bar and $baz may vary:
374 sub foo : Regex('^foo$') { my ($self, $context, $bar, $baz) = @_; }
376 But what if you also defined actions for /foo/boo and /foo/boo/hoo ?
378 sub boo : Path('/foo/boo') { .. }
379 sub hoo : Path('/foo/boo/hoo') { .. }
381 Catalyst matches actions in most specific to least specific order:
385 /foo # might be /foo/bar/baz
387 So Catalyst would never mistakenly dispatch the first two URLs to the '^foo$' action.
391 You control the application flow with the C<forward> method, which accepts the key of an action to execute.
394 my ( $self, $c ) = @_;
395 $c->stash->{message} = 'Hello World!';
396 $c->forward('check-message');
399 sub check-message : Private {
400 my ( $self, $c ) = @_;
401 return unless $c->stash->{message};
402 $c->forward('show-message');
405 sub show-message : Private {
406 my ( $self, $c ) = @_;
407 $c->res->output( $c->stash->{message} );
410 As you can see from these examples, you can just use the method name as long as you are referring to methods in the same controller. If you want to forward to a method in another controller, or the main application, you will have to refer to the method by asbolute path.
412 $c->forward('/my/controller/action');
413 $c->forward('/default');
415 You can also forward to classes and methods.
418 my ( $self, $c ) = @_;
419 $c->forward(qw/MyApp::M::Hello say_hello/);
423 my ( $self, $c ) = @_;
424 $c->forward('MyApp::M::Hello');
427 package MyApp::M::Hello;
430 my ( $self, $c ) = @_;
431 $c->res->output('Hello World!');
435 my ( $self, $c ) = @_;
436 $c->res->output('Goodbye World!');
439 Note that C<forward> returns to the calling action and continues processing after the action finishes.
440 Catalyst will automatically try to call process() if you omit the method.
444 Again, Catalyst has an uncommonly flexible component system. You can define as many L<Models>, L<Views> and L<Controllers> as you like.
446 All components must inherit from L<Catalyst::Base>, which provides a simple class structure and some common class methods like C<config> and C<new> (constructor).
448 package MyApp::C::MyController;
451 use base 'Catalyst::Base';
453 __PACKAGE__->config( foo => 'bar' );
457 You don't have to C<use> or otherwise register Models, Views and Controllers. Catalyst automatically discovers and instantiates them when you call setup in the main application. All you need to do is put them in directories named for each Component type. Notice that you can use some very terse aliases for each one.
461 =item * B<MyApp/Model/>
465 =item * B<MyApp/View/>
469 =item * B<MyApp/Controller/>
477 To show how to define views, we'll use an already-existing base class for the L<Template Toolkit|Template>, L<Catalyst::View::TT>. All we need to do is inherit from this class:
479 package MyApp::V::TT;
482 use base 'Catalyst::View::TT';
486 This gives us a process() method and we can now just do $c->forward('MyApp::V::TT') to render our templates. The base class makes process() implicit, so we don't have to say C<$c-E<gt>forward(qw/MyApp::V::TT process/)>.
489 my ( $self, $c ) = @_;
490 $c->stash->{template} = 'hello.tt';
494 my ( $self, $c ) = @_;
495 $c->forward('MyApp::V::TT');
498 You normally render templates at the end of a request, so it's a perfect use for the global end action.
500 Also, be sure to put the template under the directory specified in C<$c-E<gt>config->{root}>, or you'll be forced to look at our eyecandy debug screen. ;)
504 To show how to define models, again we'll use an already-existing base class, this time for L<Class::DBI>: L<Catalyst::Model::CDBI>.
506 But first, we need a database.
510 id INTEGER PRIMARY KEY,
515 id INTEGER PRIMARY KEY,
516 foo INTEGER REFERENCES foo,
520 INSERT INTO foo (data) VALUES ('TEST!');
523 % sqlite /tmp/myapp.db < myapp.sql
525 Now we can create a CDBI component for this database.
527 package MyApp::M::CDBI;
530 use base 'Catalyst::Model::CDBI';
533 dsn => 'dbi:SQLite:/tmp/myapp.db',
539 Catalyst automatically loads table layouts and relationships. Use the stash to pass data to your templates.
544 use Catalyst '-Debug';
547 name => 'My Application',
548 root => '/home/joeuser/myapp/root'
554 my ( $self, $c ) = @_;
555 $c->stash->{template} ||= 'index.tt';
556 $c->forward('MyApp::V::TT');
560 my ( $self, $c, $id ) = @_;
561 $c->stash->{item} = MyApp::M::CDBI::Foo->retrieve($id);
566 The id is [% item.data %]
570 Multiple Controllers are a good way to separate logical domains of your application.
572 package MyApp::C::Login;
574 sign-in : Relative { }
575 new-password :Relative { }
576 sign-out : Relative { }
578 package MyApp::C::Catalog;
583 package MyApp::C::Cart;
586 sub update : Local { }
587 sub order : Local { }
591 Catalyst has a built in http server for testing! (Later, you can easily use a more powerful server, e.g. Apache/mod_perl, in a production environment).
593 Start your application on the command line...
597 ...then visit http://localhost:3000/ in a browser to view the output.
599 You can also do it all from the command line:
601 script/test.pl http://localhost/
609 Join #catalyst on irc.perl.org.
613 http://lists.rawmode.org/mailman/listinfo/catalyst
614 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
618 Sebastian Riedel, C<sri@oook.de>
619 David Naughton, C<naughton@umn.edu>
620 Marcus Ramberg, C<mramberg@cpan.org>
624 This program is free software, you can redistribute it and/or modify it under
625 the same terms as Perl itself.