4 use base 'Class::Data::Inheritable';
5 use UNIVERSAL::require;
8 __PACKAGE__->mk_classdata($_) for qw/_config engine log/;
10 our $VERSION = '4.33';
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);
147 *{"$caller\::handler"} =
148 sub { Catalyst::Engine::handler( $caller, @_ ) };
150 unless ( $caller->isa($self) ) {
151 push @{"$caller\::ISA"}, $self;
155 unless ( $caller->log ) {
156 $caller->log( Catalyst::Log->new );
161 $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI';
166 *{"$caller\::debug"} = sub { 1 };
167 $caller->log->debug('Debug messages enabled');
169 elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" }
170 elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) }
172 my $plugin = "Catalyst::Plugin::$_";
174 # Plugin caller should be our application class
175 eval "package $caller; require $plugin";
177 $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/);
180 $caller->log->debug(qq/Loaded plugin "$plugin"/)
183 push @{"$caller\::ISA"}, $plugin;
189 $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}"
190 if $ENV{CATALYST_ENGINE};
192 die qq/Couldn't load engine "$engine", "$@"/ if $@;
195 push @{"$caller\::ISA"}, $engine;
197 $caller->engine($engine);
198 $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
203 Contains the engine class.
207 Contains the logging object. Unless it is already set Catalyst sets this up with a
208 C<Catalyst::Log> object. To use your own log class:
210 $c->log( MyLogger->new );
211 $c->log->info("now logging with my own logger!");
213 Your log class should implement the methods described in the C<Catalyst::Log>
223 Join #catalyst on irc.perl.org.
227 http://lists.rawmode.org/mailman/listinfo/catalyst
228 http://lists.rawmode.org/mailman/listinfo/catalyst-dev
232 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
233 L<Catalyst::Response>, L<Catalyst::Engine>
237 Sebastian Riedel, C<sri@oook.de>
241 Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks,
242 Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones,
243 Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa
244 and all the others who've helped.
248 This library is free software . You can redistribute it and/or modify it under
249 the same terms as perl itself.