4 use base 'Class::Data::Inheritable';
5 use UNIVERSAL::require;
8 __PACKAGE__->mk_classdata($_) for qw/_config engine log/;
10 our $VERSION = '4.34';
15 Catalyst - The Elegant MVC Web Application Framework
19 # use the helper to start a new application
23 # add models, views, controllers
24 script/create.pl model Something
25 script/create.pl view Stuff
26 script/create.pl controller Yada
31 # command line interface
37 use Catalyst qw/My::Module My::OtherModule/;
39 use Catalyst '-Debug';
41 use Catalyst qw/-Debug -Engine=CGI/;
43 __PACKAGE__->action( '!default' => sub { $_[1]->res->output('Hello') } );
47 my ( $self, $c ) = @_;
48 $c->res->output('Hello');
54 '/^product[_]*(\d*).html$/' => sub {
55 my ( $self, $c ) = @_;
56 $c->stash->{template} = 'product.tt';
57 $c->stash->{product} = $c->req->snippets->[0];
61 See also L<Catalyst::Manual::Intro>
65 Catalyst is based upon L<Maypole>, which you should consider for smaller
68 The key concept of Catalyst is DRY (Don't Repeat Yourself).
70 See L<Catalyst::Manual> for more documentation.
72 Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
73 Omit the C<Catalyst::Plugin::> prefix from the plugin name,
74 so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
76 use Catalyst 'My::Module';
78 Special flags like -Debug and -Engine can also be specifed as arguments when
81 use Catalyst qw/-Debug My::Module/;
83 The position of plugins and flags in the chain is important, because they are
84 loaded in exactly the order that they appear.
86 The following flags are supported:
92 enables debug output, i.e.:
94 use Catalyst '-Debug';
96 this is equivalent to:
103 Force Catalyst to use a specific engine.
104 Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
106 use Catalyst '-Engine=CGI';
116 Overload to enable debug messages.
124 Returns a hashref containing your applications settings.
130 $self->_config( {} ) unless $self->_config;
132 my $config = $_[1] ? {@_} : $_[0];
133 while ( my ( $key, $val ) = each %$config ) {
134 $self->_config->{$key} = $val;
137 return $self->_config;
141 my ( $self, @options ) = @_;
142 my $caller = caller(0);
144 unless ( $caller->isa($self) ) {
146 push @{"$caller\::ISA"}, $self;
149 unless ( $caller->log ) {
150 $caller->log( Catalyst::Log->new );
155 $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI';
160 *{"$caller\::debug"} = sub { 1 };
161 $caller->log->debug('Debug messages enabled');
163 elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
164 elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
166 my $plugin = "Catalyst::Plugin::$_";
168 # Plugin caller should be our application class
169 eval "package $caller; require $plugin";
171 $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/);
174 $caller->log->debug(qq/Loaded plugin "$plugin"/)
177 push @{"$caller\::ISA"}, $plugin;
183 $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
184 if $ENV{CATALYST_ENGINE};
186 die qq/Couldn't load engine "$engine", "$@"/ if $@;
189 push @{"$caller\::ISA"}, $engine;
191 $caller->engine($engine);
192 $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
197 Contains the engine class.
201 Contains the logging object. Unless it is already set Catalyst sets this up with a
202 C<Catalyst::Log> object. To use your own log class:
204 $c->log( MyLogger->new );
205 $c->log->info("now logging with my own logger!");
207 Your log class should implement the methods described in the C<Catalyst::Log>
217 Join #catalyst on irc.perl.org.
221 http://lists.rawmode.org/mailman/listinfo/catalyst
222 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
226 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
227 L<Catalyst::Response>, L<Catalyst::Engine>
231 Sebastian Riedel, C<sri@oook.de>
235 Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks,
236 Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones,
237 Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa
238 and all the others who've helped.
242 This library is free software . You can redistribute it and/or modify it under
243 the same terms as perl itself.