From: Marcus Ramberg Date: Sun, 23 Apr 2006 19:21:17 +0000 (+0000) Subject: prepared for release X-Git-Tag: 5.7099_04~617 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=b4b01a8af03edee28ae4d64b054dea6ea51fb511 prepared for release updated main pod, catalyst.pl pod --- diff --git a/Changes b/Changes index 3ad10bb..9882b7b 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,6 @@ This file documents the revision history for Perl extension Catalyst. -5.67 +5.67 2006-04-23 08:50:00 - Added $c->req->uri_with() helper - ConfigLoader: Updated to version 0.05 - Fix up Engine to avoid a new 5.8.8 warning @@ -9,7 +9,7 @@ This file documents the revision history for Perl extension Catalyst. - Static::Simple: Unescape the URI path before looking for the file. This fixes issues with files that have spaces. - Looping and recursion tests plus a fix - - Added lots of API documentation. + - Added lots of API documentation. Refactored main pod. - Changed default behaviors for $c->model/$c->controller/$c->view to more sane settings. - added the clear_errors method - an alias for error(0) diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 319684d..e18ba6c 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -87,7 +87,7 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS - # use the helper to start a new application + # use the helper to create a new application catalyst.pl MyApp # add models, views, controllers @@ -101,15 +101,16 @@ Catalyst - The Elegant MVC Web Application Framework # command line testing interface script/myapp_test.pl /yada - ### in MyApp.pm + ### in lib/MyApp.pm use Catalyst qw/-Debug/; # include plugins here as well + ### In libMyApp/Controller/Root.pm (autocreated) sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc. my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2 $c->stash->{template} = 'foo.tt'; # set the template # lookup something from db -- stash vars are passed to TT $c->stash->{data} = - MyApp::Model::Database::Foo->search( { country => $args[0] } ); + $c->model('Database::Foo')->search( { country => $args[0] } ); if ( $c->req->params->{bar} ) { # access GET or POST parameters $c->forward( 'bar' ); # process another action # do something else after forward returns @@ -127,7 +128,7 @@ Catalyst - The Elegant MVC Web Application Framework # called for all actions, from the top-most controller downwards sub auto : Private { my ( $self, $c ) = @_; - if ( !$c->user ) { + if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication $c->res->redirect( '/login' ); # require login return 0; # abort request and go immediately to end() } @@ -156,7 +157,7 @@ Catalyst - The Elegant MVC Web Application Framework # called for /foo/bar/baz sub baz : Local { ... } - # first MyApp auto is called, then Foo auto, then this + # first Root auto is called, then Foo auto, then this sub auto : Private { ... } # powerful regular expression paths are also possible @@ -170,7 +171,7 @@ See L for additional information. =head1 DESCRIPTION -The key concept of Catalyst is DRY (Don't Repeat Yourself). +Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L or L See L for more documentation. @@ -244,16 +245,16 @@ corresponding to the controller of the current action. For example: Returns the current L object. See L. -=head2 PROCESSING AND RESPONSE TO THE CURRENT REQUEST +=head2 REQUEST FLOW HANDLING =head2 $c->forward( $action [, \@arguments ] ) =head2 $c->forward( $class, $method, [, \@arguments ] ) -Forwards processing to a private action. 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, +Forwards processing to another action, by it's 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. Any data Ced from the action forwarded to, will be returned by the @@ -284,12 +285,47 @@ sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } =head2 $c->detach( $class, $method, [, \@arguments ] ) -The same as C, but doesn't return. +The same as C, but doesn't return to the previous action when +processing is finished. =cut sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +=head2 $c->response + +=head2 $c->res + +Returns the current L object. + +=head2 $c->stash + +Returns a hashref to the stash, which may be used to store data and pass +it between components during a request. You can also set hash keys by +passing arguments. The stash is automatically sent to the view. The +stash is cleared at the end of a request; it cannot be used for +persistent storage. + + $c->stash->{foo} = $bar; + $c->stash( { moose => 'majestic', qux => 0 } ); + $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' ); + +=cut + +sub stash { + my $c = shift; + if (@_) { + my $stash = @_ > 1 ? {@_} : $_[0]; + while ( my ( $key, $val ) = each %$stash ) { + $c->{stash}->{$key} = $val; + } + } + return $c->{stash}; +} + =head2 $c->error =head2 $c->error($error, ...) @@ -319,6 +355,11 @@ sub error { return $c->{error} || []; } + +=head2 $c->state + +Contains the return value of the last executed action. + =head2 $c->clear_errors Clear errors. You probably don't want to clear the errors unless you are @@ -335,45 +376,8 @@ sub clear_errors { $c->error(0); } -=head2 $c->response - -=head2 $c->res - -Returns the current L object. - -=head2 $c->stash - -Returns a hashref to the stash, which may be used to store data and pass -it between components during a request. You can also set hash keys by -passing arguments. The stash is automatically sent to the view. The -stash is cleared at the end of a request; it cannot be used for -persistent storage. - - $c->stash->{foo} = $bar; - $c->stash( { moose => 'majestic', qux => 0 } ); - $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' ); - -=cut - -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; - } - } - return $c->{stash}; -} - -=head2 $c->state -Contains the return value of the last executed action. -=cut # search via regex sub _comp_search { @@ -459,42 +463,6 @@ sub _filter_component { =head2 COMPONENT ACCESSORS -=head2 $c->comp($name) - -=head2 $c->component($name) - -Gets a component object by name. This method is no longer recommended, -unless you want to get a specific component by full -class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> -should be used instead. - -=cut - -sub component { - my $c = shift; - - if (@_) { - - my $name = shift; - - my $appclass = ref $c || $c; - - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } - qw/Model M Controller C View V/ - ); - - my $comp = $c->_comp_explicit(@names); - return $c->_filter_component( $comp, @_ ) if defined($comp); - - $comp = $c->_comp_search($name); - return $c->_filter_component( $comp, @_ ) if defined($comp); - } - - return sort keys %{ $c->components }; -} - =head2 $c->controller($name) Gets a L instance by name. @@ -513,17 +481,6 @@ sub controller { return $c->component( $c->action->class ); } -=head2 $c->controllers - -Returns the available names which can be passed to $c->controller - -=cut - -sub controllers { - my ( $c ) = @_; - return $c->_comp_names(qw/Controller C/); -} - =head2 $c->model($name) Gets a L instance by name. @@ -546,17 +503,18 @@ sub model { } -=head2 $c->models +=head2 $c->controllers -Returns the available names which can be passed to $c->model +Returns the available names which can be passed to $c->controller =cut -sub models { +sub controllers { my ( $c ) = @_; - return $c->_comp_names(qw/Model M/); + return $c->_comp_names(qw/Controller C/); } + =head2 $c->view($name) Gets a L instance by name. @@ -578,6 +536,18 @@ sub view { return $c->_filter_component( $c->_comp_singular(qw/View V/) ); } +=head2 $c->models + +Returns the available names which can be passed to $c->model + +=cut + +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} + + =head2 $c->views Returns the available names which can be passed to $c->view @@ -589,7 +559,45 @@ sub views { return $c->_comp_names(qw/View V/); } -=head2 Class data and helper classes +=head2 $c->comp($name) + +=head2 $c->component($name) + +Gets a component object by name. This method is no longer recommended, +unless you want to get a specific component by full +class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> +should be used instead. + +=cut + +sub component { + my $c = shift; + + if (@_) { + + my $name = shift; + + my $appclass = ref $c || $c; + + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); + + my $comp = $c->_comp_explicit(@names); + return $c->_filter_component( $comp, @_ ) if defined($comp); + + $comp = $c->_comp_search($name); + return $c->_filter_component( $comp, @_ ) if defined($comp); + } + + return sort keys %{ $c->components }; +} + + + +=head2 CLASS DATA AND HELPER CLASSES =head2 $c->config @@ -603,6 +611,7 @@ applications home directory. --- db: dsn:SQLite:foo.db + =cut sub config { @@ -614,24 +623,6 @@ sub config { $c->NEXT::config(@_); } -=head2 $c->debug - -Overload to enable debug messages (same as -Debug option). - -=cut - -sub debug { 0 } - -=head2 $c->dispatcher - -Returns the dispatcher instance. Stringifies to class name. See -L. - -=head2 $c->engine - -Returns the engine instance. Stringifies to the class name. See -L. - =head2 $c->log Returns the logging object instance. Unless it is already set, Catalyst sets @@ -649,8 +640,26 @@ And later: Your log class should implement the methods described in the L man page. + +=head2 $c->debug + +Overload to enable debug messages (same as -Debug option). + =cut +sub debug { 0 } + +=head2 $c->dispatcher + +Returns the dispatcher instance. Stringifies to class name. See +L. + +=head2 $c->engine + +Returns the engine instance. Stringifies to the class name. See +L. + + =head2 UTILITY METHODS =head2 $c->path_to(@path) @@ -1542,7 +1551,7 @@ sub prepare { =head2 $c->prepare_action -Prepares action. +Prepares action. See L. =cut @@ -1581,6 +1590,8 @@ sub prepare_body { Prepares a chunk of data before sending it to L. +See L. + =cut sub prepare_body_chunk { diff --git a/script/catalyst.pl b/script/catalyst.pl index 3edd122..85d30c9 100755 --- a/script/catalyst.pl +++ b/script/catalyst.pl @@ -40,14 +40,19 @@ catalyst - Bootstrap a Catalyst application catalyst.pl [options] application-name +'catalyst.pl' creates a skeleton for a new application, and allows you to +upgrade the skeleton of your old application. + Options: -force don't create a .new file where a file to be created exists - -help display this help and exits - -makefile update Makefile.PL only - -scripts update helper scripts only - -short use short types, like C instead of Controller... + -help display this help and exit + -makefile only update Makefile.PL + -scripts only update helper scripts + -short use short names, M/V/C instead of Model/View/Controller. + + application-name must be a valid Perl module name and can include "::", + which will be converted to '-' in the project name. - application-name must be a valid Perl module name and can include "::" Examples: catalyst.pl My::App