X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=328a3582c8bdff955ba9a9cf18c4f5135dc18b34;hb=d96e14c21fb544597f459aaaad969c34af7f2d1f;hp=0be104f1ea63dc26526588fab1bebd524553b472;hpb=91864987dc0e2256fe00b94853ba5b3a18f01ea2;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 0be104f..328a358 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -5,9 +5,9 @@ use base 'Class::Data::Inheritable'; use UNIVERSAL::require; use Catalyst::Log; -__PACKAGE__->mk_classdata($_) for qw/_config log/; +__PACKAGE__->mk_classdata($_) for qw/_config engine log/; -our $VERSION = '4.20'; +our $VERSION = '5.00'; our @ISA; =head1 NAME @@ -21,18 +21,15 @@ Catalyst - The Elegant MVC Web Application Framework cd MyApp # add models, views, controllers - bin/create.pl model Something - bin/create.pl view Stuff - bin/create.pl controller Yada + script/create.pl model Something + script/create.pl view Stuff + script/create.pl controller Yada # built in testserver - bin/server.pl + script/server.pl # command line interface - bin/test.pl /yada - - - See also L + script/test.pl /yada use Catalyst; @@ -61,6 +58,8 @@ Catalyst - The Elegant MVC Web Application Framework } ); +See also L + =head1 DESCRIPTION Catalyst is based upon L, which you should consider for smaller @@ -70,37 +69,49 @@ The key concept of Catalyst is DRY (Don't Repeat Yourself). See L for more documentation. -Omit the Catalyst::Plugin:: prefix from plugins. -So Catalyst::Plugin::My::Module becomes My::Module. +Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. +Omit the C prefix from the plugin name, +so C becomes C. use Catalyst 'My::Module'; -You can also set special flags like -Debug and -Engine. +Special flags like -Debug and -Engine can also be specifed as arguments when +Catalyst is loaded: use Catalyst qw/-Debug My::Module/; -The position of plugins and flags in the chain is important, -because they are loaded in the same order they appear. +The position of plugins and flags in the chain is important, because they are +loaded in exactly the order that they appear. + +The following flags are supported: + +=over 4 -=head2 -Debug +=item -Debug + +enables debug output, i.e.: use Catalyst '-Debug'; -is equivalent to +this is equivalent to: use Catalyst; sub debug { 1 } -=head2 -Engine +=item -Engine Force Catalyst to use a specific engine. -Omit the Catalyst::Engine:: prefix. +Omit the C prefix of the engine name, i.e.: use Catalyst '-Engine=CGI'; -=head2 METHODS +=back + +=head1 METHODS -=head3 debug +=over 4 + +=item debug Overload to enable debug messages. @@ -108,7 +119,7 @@ Overload to enable debug messages. sub debug { 0 } -=head3 config +=item config Returns a hashref containing your applications settings. @@ -130,23 +141,35 @@ sub import { my ( $self, @options ) = @_; my $caller = caller(0); - # Class - { + unless ( $caller->isa($self) ) { no strict 'refs'; - *{"$caller\::handler"} = - sub { Catalyst::Engine::handler( $caller, @_ ) }; push @{"$caller\::ISA"}, $self; } - $self->log( Catalyst::Log->new ); + + if ( $caller->engine ) { + return; # Catalyst is allready initialized + } + + unless ( $caller->log ) { + $caller->log( Catalyst::Log->new ); + } + + if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { + no strict 'refs'; + *{"$caller\::debug"} = sub { 1 }; + $caller->log->debug('Debug messages enabled'); + } # Options - my $engine = - $ENV{MOD_PERL} ? 'Catalyst::Engine::Apache' : 'Catalyst::Engine::CGI'; + my $engine = $ENV{MOD_PERL} + ? 'Catalyst::Engine::Apache' + : 'Catalyst::Engine::CGI'; + foreach (@options) { if (/^\-Debug$/) { - no warnings; + next if $caller->debug; no strict 'refs'; - *{"$self\::debug"} = sub { 1 }; + *{"$caller\::debug"} = sub { 1 }; $caller->log->debug('Debug messages enabled'); } elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } @@ -162,7 +185,8 @@ sub import { else { $caller->log->debug(qq/Loaded plugin "$plugin"/) if $caller->debug; - unshift @ISA, $plugin; + no strict 'refs'; + push @{"$caller\::ISA"}, $plugin; } } } @@ -170,12 +194,52 @@ sub import { # Engine $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" if $ENV{CATALYST_ENGINE}; + + if ( $engine eq 'Catalyst::Engine::Server' ) { + $engine = 'Catalyst::Engine::HTTP::Daemon'; + $caller->log->warn( "Catalyst::Engine::Server is deprecated, " + . "using Catalyst::Engine::HTTP::Daemon." ); + } + $engine->require; die qq/Couldn't load engine "$engine", "$@"/ if $@; - push @ISA, $engine; + { + no strict 'refs'; + push @{"$caller\::ISA"}, $engine; + } + $caller->engine($engine); $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; } +=item $c->engine + +Contains the engine class. + +=item $c->log + +Contains the logging object. Unless it is already set Catalyst sets this up with a +C object. To use your own log class: + + $c->log( MyLogger->new ); + $c->log->info("now logging with my own logger!"); + +Your log class should implement the methods described in the C +man page. + + +=back + +=head1 SUPPORT + +IRC: + + Join #catalyst on irc.perl.org. + +Mailing-Lists: + + http://lists.rawmode.org/mailman/listinfo/catalyst + http://lists.rawmode.org/mailman/listinfo/catalyst-dev + =head1 SEE ALSO L, L, L, @@ -187,8 +251,10 @@ Sebastian Riedel, C =head1 THANK YOU -Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse Sheidlower, -Johan Lindstrom, Marcus Ramberg and all the others who've helped. +Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks, +Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones, +Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa +and all the others who've helped. =head1 LICENSE