X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FCookbook.pod;h=2cfdf771dbdc3830a2c9f5fe435bff701401dfc3;hb=26e731318112842b5a605bec2092ccae3369c5e4;hp=af8d13e78466efe829110fa00929d3695dadf727;hpb=f25a32836c7c60ea3c89aebec41f7edf82133ea6;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Manual/Cookbook.pod b/lib/Catalyst/Manual/Cookbook.pod
index af8d13e..2cfdf77 100644
--- a/lib/Catalyst/Manual/Cookbook.pod
+++ b/lib/Catalyst/Manual/Cookbook.pod
@@ -84,7 +84,7 @@ Other Scaffolding modules are in development at the time of writing.
 
 =head3 Single file upload with Catalyst
 
-To implement uploads in Catalyst you need to have a HTML form similiar to
+To implement uploads in Catalyst, you need to have a HTML form similar to
 this:
 
     <form action="/upload" method="post" enctype="multipart/form-data">
@@ -208,7 +208,7 @@ To log in a user you might use an action like this:
             $c->session_login($c->req->params->{username}, 
                               $c->req->params->{password} );
             if ($c->req->{user}) {
-                $c->forward('?restricted_area');
+                $c->forward('/restricted_area');
             }
         }
     }
@@ -266,32 +266,32 @@ with:
     sub add : Local {
         my ($self, $c) = @_;
         if ($c->roles(qw/admin/)) {
-            $c->req->output("Your account has the role 'admin.'");
+            $c->res->output("Your account has the role 'admin.'");
         } else {
-            $c->req->output("You're not allowed to be here.");
+            $c->res->output("You're not allowed to be here.");
         }
     }
 
 One thing you might need is to forward non-authenticated users to a login 
 form if they try to access restricted areas. If you want to do this 
 controller-wide (if you have one controller for your admin section) then it's 
-best to add a user check to a '!begin' action:
+best to add a user check to a 'begin' action:
 
     sub begin : Private {
         my ($self, $c) = @_;
         unless ($c->req->{user}) {
             $c->req->action(undef);  ## notice this!!
-            $c->forward('?login');
+            $c->forward('/user/login');
         }
     }
 
-Pay attention to $c->req->action(undef). This is needed because of the 
-way $c->forward works - C<forward> to C<login> gets called, but after that 
-Catalyst will still execute the action defined in the URI (e.g. if you 
-tried to go to C</add>, then first 'begin' will forward to 'login', but after
-that 'add' will nonetheless be executed). So $c->req->action(undef) undefines any 
-actions that were to be called and forwards the user where we want him/her 
-to be.
+Pay attention to $c->req->action(undef). This is needed because of the
+way $c->forward works - C<forward> to C<login> gets called, but after
+that Catalyst will still execute the action defined in the URI (e.g. if
+you tried to go to C</add>, then first 'begin' will forward to 'login',
+but after that 'add' will nonetheless be executed). So
+$c->req->action(undef) undefines any actions that were to be called and
+forwards the user where we want him/her to be.
 
 And this is all you need to do. 
 
@@ -463,7 +463,7 @@ favicon.ico by using this in your HTML header:
 
 The Static plugin makes use of the C<shared-mime-info> package to
 automatically determine MIME types. This package is notoriously
-difficult to install, especially on win32 and OSX. For OSX the easiest
+difficult to install, especially on win32 and OS X. For OS X the easiest
 path might be to install Fink, then use C<apt-get install
 shared-mime-info>. Restart the server, and everything should be fine.
 
@@ -485,8 +485,7 @@ When using Apache, you can completely bypass Catalyst and the Static
 controller by intercepting requests for the C<root/static> path at the
 server level. All that is required is to define a DocumentRoot and add a
 separate Location block for your static content. Here is a complete
-config for this application under mod_perl 1.x; variations, some of
-which could be simpler, are left as an exercise for the reader:
+config for this application under mod_perl 1.x:
 
     <Perl>
         use lib qw(/var/www/MyApp/lib);
@@ -505,6 +504,13 @@ which could be simpler, are left as an exercise for the reader:
         </LocationMatch>
     </VirtualHost>
 
+And here's a simpler example that'll get you started:
+
+    Alias /static/ "/my/static/files/"
+    <Location "/static">
+        SetHandler none
+    </Location>
+
 =head2 Forwarding with arguments
 
 Sometimes you want to pass along arguments when forwarding to another
@@ -602,20 +608,43 @@ simple component in Catalyst that slurps in an outside Model:
 and that's it! Now C<Some::Other::CDBI::Module::Catalog> is part of your
 Cat app as C<MyApp::M::Catalog>.
 
-=head1 Serving static files with Apache.
+=head2 Delivering a Custom Error Page
 
-When deploying your application it's a waste to serve static files 
-with Catalyst. Instead, set up something like this:
+By default, Catalyst will display its own error page whenever it
+encounters an error in your application. When running under C<-Debug>
+mode, the error page is a useful screen including the error message and
+a full Data::Dumper output of the C<$c> context object. When not in
+C<-Debug>, users see a simple "Please come back later" screen.
 
-    Alias /static/ "/my/static/files/"
-    <Location "/static">
-    SetHandler none
-    </Location>
+To use a custom error page, use a special C<end> method to short-circuit
+the error processing. The following is an example; you might want to
+adjust it further depending on the needs of your application (for
+example, any calls to C<fillform> will probably need to go into this
+C<end> method; see L<Catalyst::Plugin::FillInForm>).
 
-To match the location of your static files. 
+    sub end : Private {
+        my ( $self, $c ) = @_;
+    
+        if ( scalar @{ $c->error } ) {
+            $c->stash->{errors}   = $c->error;
+            $c->stash->{template} = 'errors.tt';
+            $c->forward('MyApp::View::TT');
+            $c->{error} = [];
+        }
+    
+        return 1 if $c->response->status =~ /^3\d\d$/;
+        return 1 if $c->response->body;
+    
+        unless ( $c->response->content_type ) {
+            $c->response->content_type('text/html; charset=utf-8');
+        }
+    
+        $c->forward('MyApp::View::TT');
+    }
 
+You can manually set errors in your code to trigger this page by calling
 
-=cut
+    $c->error( 'You broke me!' );
 
 =head1 AUTHOR