X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=9e73489b339cfd540abddda1d2b0d5d95029ec0a;hb=b41ee0975bfd2664027c3f0b0d839cff8fb1aaa2;hp=510411cb44fe7367887e0b81d6768ce5f66bd4f6;hpb=37553dc8c4a1b2113be2f2bc7b3bb701f76bb524;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 510411c..9e73489 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -17,7 +17,9 @@ use Time::HiRes qw/gettimeofday tv_interval/; use URI; use Scalar::Util qw/weaken/; -__PACKAGE__->mk_accessors(qw/counter depth request response state/); +__PACKAGE__->mk_accessors( + qw/counter depth request response state action namespace/ +); # Laziness++ *comp = \&component; @@ -36,12 +38,12 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 7; +our $CATALYST_SCRIPT_GEN = 9; __PACKAGE__->mk_classdata($_) for qw/components arguments dispatcher engine log/; -our $VERSION = '5.49_01'; +our $VERSION = '5.49_02'; sub import { my ( $class, @arguments ) = @_; @@ -167,6 +169,10 @@ Specify log level. =over 4 +=item $c->action + +Accessor for the current action + =item $c->comp($name) =item $c->component($name) @@ -251,6 +257,27 @@ from the function. sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +=item $c->namespace + +Accessor to the namespace of the current action + +=item $c->path_to(@path) + +Merges C<@path> with $c->config->{home} and returns a L object. + +For example: + + $c->path_to( 'db', 'sqlite.db' ); + +=cut + +sub path_to { + my ( $c, @path ) = @_; + my $path = dir( $c->config->{home}, @path ); + if ( -d $path ) { return $path } + else { return file( $c->config->{home}, @path ) } +} + =item $c->setup Setup. @@ -379,27 +406,33 @@ sub setup { $class->log->_flush() if $class->log->can('_flush'); } -=item $c->uri_for($path) +=item $c->uri_for($path,[@args]) Merges path with $c->request->base for absolute uri's and with $c->request->match for relative uri's, then returns a normalized -L object. +L object. If any args are passed, they are added at the end +of the path. =cut sub uri_for { - my ( $c, $path ) = @_; + my ( $c, $path, @args ) = @_; my $base = $c->request->base->clone; my $basepath = $base->path; $basepath =~ s/\/$//; $basepath .= '/'; my $match = $c->request->match; + + # massage match, empty if absolute path $match =~ s/^\///; $match .= '/' if $match; $match = '' if $path =~ /^\//; $path =~ s/^\///; - return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base ) - ->canonical; + + # join args with '/', or a blank string + my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); + return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ), + $base )->canonical; } =item $c->error @@ -416,13 +449,20 @@ Add a new error. $c->error('Something bad happened'); +Clean errors. + + $c->error(0); + =cut sub error { my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; + if ( $_[0] ) { + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$error; + } + elsif ( defined $_[0] ) { $c->{error} = undef } + return $c->{error} || []; } =item $c->engine @@ -500,9 +540,17 @@ Contains the return value of the last executed action. Returns a hashref containing all your data. - $c->stash->{foo} ||= 'yada'; print $c->stash->{foo}; +Keys may be set in the stash by assigning to the hash reference, or by passing +either a single hash reference or a list of key/value pairs as arguments. + +For example: + + $c->stash->{foo} ||= 'yada'; + $c->stash( { moose => 'majestic', qux => 0 } ); + $c->stash( bar => 1, gorch => 2 ); + =cut sub stash { @@ -516,6 +564,146 @@ sub stash { return $c->{stash}; } +=item $c->welcome_message + +Returns the Catalyst welcome HTML page. + +=cut + +sub welcome_message { + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + return <<"EOF"; + + + $name on Catalyst $VERSION + + + +
+
+

$name on Catalyst + $VERSION

+
+
+

+ +

+

Welcome to the wonderful world of Catalyst. + This MVC + framework will make web development something you had + never expected it to be: Fun, rewarding and quick.

+

What to do now?

+

That really depends on what you want to do. + We do, however, provide you with a few starting points.

+

If you want to jump right into web development with Catalyst + you might want to check out the documentation.

+
perldoc Catalyst::Manual::Intro
+perldoc Catalyst::Manual
+

What to do next?

+

Next it's time to write an actual application. Use the + helper scripts to generate controllers, + models and + views, + they can save you a lot of work.

+
script/${prefix}_create.pl -help
+

Also, be sure to check out the vast and growing + collection of plugins for Catalyst on CPAN, + you are likely to find what you need there. +

+ +

Need help?

+

Catalyst has a very active community. Here are the main places to + get in touch with us.

+ +

In conclusion

+

The Catalyst team hopes you will enjoy using Catalyst as much + as we enjoyed making it. Please contact us if you have ideas + for improvement or other feedback.

+
+
+ + +EOF +} + =back =head1 INTERNAL METHODS @@ -599,7 +787,9 @@ sub execute { push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; $c->state(@state); } - else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ) } + else { + $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ); + } }; $c->{depth}--; @@ -1361,6 +1551,15 @@ sub write { return $c->engine->write( $c, @_ ); } +=item version + +Returns the Catalyst version number. mostly useful for powered by messages +in template systems. + +=cut + +sub version { return $Catalyst::VERSION } + =back =head1 CASE SENSITIVITY @@ -1462,6 +1661,10 @@ Andy Grundman Andy Wardley +Andreas Marienborg + +Andrew Bramble + Andrew Ford Andrew Ruthven @@ -1514,8 +1717,8 @@ Sebastian Riedel, C =head1 LICENSE -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software, you can redistribute it and/or modify it under +the same terms as Perl itself. =cut