X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=04d8d82ac3466f0c845e92bbf3af07fe49f53f91;hb=e422816ee11aca47515850b63d599e8e003ca7d5;hp=2a85d29a15c34f699bdc70eff94953229cfce587;hpb=908e3d9e7a61974b3807b7ab37862550452b2456;p=catagits%2FCatalyst-Runtime.git
diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 2a85d29..04d8d82 100644
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -61,7 +61,7 @@ __PACKAGE__->response_class('Catalyst::Response');
# Remember to update this in Catalyst::Runtime as well!
-our $VERSION = '5.7003';
+our $VERSION = '5.7007';
sub import {
my ( $class, @arguments ) = @_;
@@ -87,16 +87,20 @@ Catalyst - The Elegant MVC Web Application Framework
=head1 SYNOPSIS
+See the L distribution for comprehensive
+documentation and tutorials.
+
# Install Catalyst::Devel for helpers and other development tools
# use the helper to create a new application
catalyst.pl MyApp
# add models, views, controllers
- script/myapp_create.pl model Database DBIC::SchemaLoader dbi:SQLite:/path/to/db
- script/myapp_create.pl view TT TT
+ script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db
+ script/myapp_create.pl view MyTemplate TT
script/myapp_create.pl controller Search
# built in testserver -- use -r to restart automatically on changes
+ # --help to see all available options
script/myapp_server.pl
# command line testing interface
@@ -224,6 +228,12 @@ Forces Catalyst to use a specific home directory, e.g.:
use Catalyst qw[-Home=/usr/mst];
+This can also be done in the shell environment by setting either the
+C environment variable or C; where C
+is replaced with the uppercased name of your application, any "::" in
+the name will be replaced with underscores, e.g. MyApp::Web should use
+MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used.
+
=head2 -Log
Specifies log level.
@@ -262,8 +272,8 @@ cookies, HTTP headers, etc.). See L.
Forwards processing to another action, by its private name. If you give a
class name but no method, C is called. You may also optionally
pass arguments in an arrayref. The action will receive the arguments in
-C<@_> and C<$c-Ereq-Eargs>. Upon returning from the function,
-C<$c-Ereq-Eargs> will be restored to the previous values.
+C<@_> and C<< $c->req->args >>. Upon returning from the function,
+C<< $c->req->args >> will be restored to the previous values.
Any data Ced from the action forwarded to, will be returned by the
call to forward.
@@ -308,7 +318,7 @@ sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) }
=head2 $c->res
-Returns the current L object, q.v.
+Returns the current L object, see there for details.
=head2 $c->stash
@@ -325,7 +335,7 @@ Catalyst).
$c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
# stash is automatically passed to the view for use in a template
- $c->forward( 'MyApp::V::TT' );
+ $c->forward( 'MyApp::View::TT' );
=cut
@@ -349,7 +359,7 @@ sub stash {
Returns an arrayref containing error messages. If Catalyst encounters an
error while processing a request, it stores the error in $c->error. This
-method should not be used to store non-fatal error messages.
+method should only be used to store fatal error messages.
my @error = @{ $c->error };
@@ -501,6 +511,8 @@ Gets a L instance by name.
$c->model('Foo')->do_stuff;
+Any extra arguments are directly passed to ACCEPT_CONTEXT.
+
If the name is omitted, it will look for
- a model object in $c->stash{current_model_instance}, then
- a model name in $c->stash->{current_model}, then
@@ -519,10 +531,10 @@ sub model {
if $c->stash->{current_model_instance};
return $c->model( $c->stash->{current_model} )
if $c->stash->{current_model};
- return $c->model( $c->config->{default_model} )
- if $c->config->{default_model};
}
- return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args );
+ return $c->model( $c->config->{default_model} )
+ if $c->config->{default_model};
+ return $c->_filter_component( $c->_comp_singular(qw/Model M/) );
}
@@ -544,6 +556,8 @@ Gets a L instance by name.
$c->view('Foo')->do_stuff;
+Any extra arguments are directly passed to ACCEPT_CONTEXT.
+
If the name is omitted, it will look for
- a view object in $c->stash{current_view_instance}, then
- a view name in $c->stash->{current_view}, then
@@ -562,9 +576,9 @@ sub view {
if $c->stash->{current_view_instance};
return $c->view( $c->stash->{current_view} )
if $c->stash->{current_view};
- return $c->view( $c->config->{default_view} )
- if $c->config->{default_view};
}
+ return $c->view( $c->config->{default_view} )
+ if $c->config->{default_view};
return $c->_filter_component( $c->_comp_singular(qw/View V/) );
}
@@ -595,9 +609,9 @@ sub views {
=head2 $c->component($name)
-Gets a component object by name. This method is no longer recommended,
+Gets a component object by name. This method is not recommended,
unless you want to get a specific component by full
-class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview>
+class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >>
should be used instead.
=cut
@@ -637,8 +651,9 @@ Returns or takes a hashref containing the application's configuration.
__PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
-You can also use a L config file like myapp.yml in your
-applications home directory.
+You can also use a C, C or C config file
+like myapp.yml in your applications home directory. See
+L.
---
db: dsn:SQLite:foo.db
@@ -699,8 +714,8 @@ L.
=head2 $c->path_to(@path)
-Merges C<@path> with C<$c-Econfig-E{home}> and returns a
-L object.
+Merges C<@path> with C<< $c->config->{home} >> and returns a
+L object.
For example:
@@ -817,6 +832,7 @@ You are running an old script!
or (this will not overwrite existing files):
catalyst.pl -scripts $class
+
EOF
}
@@ -826,7 +842,7 @@ EOF
if (@plugins) {
my $t = Text::SimpleTable->new(74);
$t->row($_) for @plugins;
- $class->log->debug( "Loaded plugins:\n" . $t->draw );
+ $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" );
}
my $dispatcher = $class->dispatcher;
@@ -861,7 +877,7 @@ EOF
my $type = ref $class->components->{$comp} ? 'instance' : 'class';
$t->row( $comp, $type );
}
- $class->log->debug( "Loaded components:\n" . $t->draw )
+ $class->log->debug( "Loaded components:\n" . $t->draw . "\n" )
if ( keys %{ $class->components } );
}
@@ -919,11 +935,13 @@ sub uri_for {
$path ||= '';
$namespace = '' if $path =~ /^\//;
$path =~ s/^\///;
+ $path =~ s/\?/%3F/g;
my $params =
( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} );
for my $value ( values %$params ) {
+ next unless defined $value;
for ( ref $value eq 'ARRAY' ? @$value : $value ) {
$_ = "$_";
utf8::encode( $_ );
@@ -931,7 +949,7 @@ sub uri_for {
};
# join args with '/', or a blank string
- my $args = ( scalar @args ? '/' . join( '/', @args ) : '' );
+ my $args = ( scalar @args ? '/' . join( '/', map {s/\?/%3F/g; $_} @args ) : '' );
$args =~ s/^\/// unless $path;
my $res =
URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base )
@@ -1035,7 +1053,7 @@ sub welcome_message {
- Welcome to the wonderful world of Catalyst.
+
Welcome to the world of Catalyst.
This MVC
framework will make web development something you had
never expected it to be: Fun, rewarding, and quick.
@@ -1043,10 +1061,14 @@ sub welcome_message {
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::Tutorial
-perldoc Catalyst::Manual
+ you might want want to start with a tutorial.
+perldoc Catalyst::Manual::Tutorial
+
+Afterwards you can go on to check out a more complete look at our features.
+
+perldoc Catalyst::Manual::Intro
+
+
What to do next?
Next it's time to write an actual application. Use the
helper scripts to generate controllers,
@@ -1327,7 +1349,7 @@ sub finalize {
);
$c->log->info(
- "Request took ${elapsed}s ($av/s)\n" . $t->draw );
+ "Request took ${elapsed}s ($av/s)\n" . $t->draw . "\n" );
}
return $c->response->status;
@@ -1373,6 +1395,13 @@ sub finalize_headers {
if ( my $location = $c->response->redirect ) {
$c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
$c->response->header( Location => $location );
+
+ if ( !$c->response->body ) {
+ # Add a default body if none is already present
+ $c->response->body(
+ qq{
This item has moved here.
}
+ );
+ }
}
# Content-Length
@@ -1755,7 +1784,7 @@ Reads a chunk of data from the request body. This method is designed to
be used in a while loop, reading C<$maxlength> bytes on every call.
C<$maxlength> defaults to the size of the request if not specified.
-You have to set Cconfig-E{parse_on_demand}> to use this
+You have to set C<< MyApp->config->{parse_on_demand} >> to use this
directly.
=cut
@@ -2030,6 +2059,7 @@ sub setup_home {
}
if ( $ENV{ uc($class) . '_HOME' } ) {
+ $class =~ s/::/_/g;
$home = $ENV{ uc($class) . '_HOME' };
}