X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=0107be049cd08a23de5063338f5c12d0268aad6c;hb=2d07aec5bb54b9e39dc4efd334f2455e66a33c83;hp=e29380de87ce533e39f82c5a90f7b2f2893dc41a;hpb=fc7ec1d96ee55d1bf42af3abce155ecb717b9e2b;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index e29380d..0107be0 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -3,60 +3,158 @@ package Catalyst::Response;
 use strict;
 use base 'Class::Accessor::Fast';
 
-__PACKAGE__->mk_accessors(qw/cookies headers output redirect status/);
+__PACKAGE__->mk_accessors(qw/cookies body headers location status/);
+
+*output = \&body;
+
+sub content_encoding { shift->headers->content_encoding(@_) }
+sub content_length   { shift->headers->content_length(@_) }
+sub content_type     { shift->headers->content_type(@_) }
+sub header           { shift->headers->header(@_) }
 
 =head1 NAME
 
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
 
 =head1 SYNOPSIS
 
-See L<Catalyst::Application>.
+    $res = $c->response;
+    $res->body;
+    $res->content_encoding;
+    $res->content_length;
+    $res->content_type;
+    $res->cookies;
+    $res->header;
+    $res->headers;
+    $res->output;
+    $res->redirect;
+    $res->status;
+    $res->write;
 
 =head1 DESCRIPTION
 
-The Catalyst Response.
+This is the Catalyst Response class, which provides methods for responding to
+the current client request. The appropriate L<Catalyst::Engine> for your environment
+will turn the Catalyst::Response into a HTTP Response and return it to the client.
+
+=head1 METHODS
+
+=head2 $res->body(<$text|$fh|$iohandle_object)
+
+    $c->response->body('Catalyst rocks!');
+
+Sets or returns the output (text or binary data). If you are returning a large body,
+you might want to use a L<IO::Handle> type of object (Something that implements the read method
+in the same fashion), or a filehandle GLOB. Catalyst
+will write it piece by piece into the response.
+
+=head2 $res->content_encoding
+
+Shortcut for $res->headers->content_encoding.
 
-=head2 METHODS
+=head2 $res->content_length
 
-=head3 cookies
+Shortcut for $res->headers->content_length.
 
-Returns a hashref containing the cookies.
+=head2 $res->content_type
+
+Shortcut for $res->headers->content_type.
+
+This value is typically set by your view or plugin. For example,
+L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
+it found, while L<Catalyst::View::TT> defaults to C<text/html>.
+
+=head2 $res->cookies
+
+Returns a reference to a hash containing cookies to be set. The keys of the
+hash are the cookies' names, and their corresponding values are hash
+references used to construct a L<CGI::Cookie> object.
 
     $c->response->cookies->{foo} = { value => '123' };
 
-=head3 headers
+The keys of the hash reference on the right correspond to the L<CGI::Cookie>
+parameters of the same name, except they are used without a leading dash.
+Possible parameters are:
+
+=over 
+
+=item value
+
+=item expires
+
+=item domain
 
-Returns a L<HTTP::Headers> object containing the headers.
+=item path
+
+=item secure
+
+=back
+
+=head2 $res->header
+
+Shortcut for $res->headers->header.
+
+=head2 $res->headers
+
+Returns an L<HTTP::Headers> object, which can be used to set headers.
 
     $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
 
-=head3 output
+=head2 $res->output
+
+Alias for $res->body.
+
+=head2 $res->redirect( $url, $status )
 
-Contains the final output.
+Causes the response to redirect to the specified URL. The default status is
+C<302>.
 
-    $c->response->output('Catalyst rockz!');
+    $c->response->redirect( 'http://slashdot.org' );
+    $c->response->redirect( 'http://slashdot.org', 307 );
 
-=head3 redirect
+This is a convenience method that sets the Location header to the
+redirect destination, and then sets the response status.  You will
+want to C< return; > or C< $c->detach() > to interrupt the normal
+processing flow if you want the redirect to occur straight away.
 
-Contains a location to redirect to.
+=cut
+
+sub redirect {
+    my $self = shift;
+
+    if (@_) {
+        my $location = shift;
+        my $status   = shift || 302;
+
+        $self->location($location);
+        $self->status($status);
+    }
 
-    $c->response->redirect('http://slashdot.org');
+    return $self->location;
+}
 
-=head3 status
+=head2 $res->status
 
-Contains the HTTP status.
+Sets or returns the HTTP status.
 
     $c->response->status(404);
+    
+=head2 $res->write( $data )
+
+Writes $data to the output stream.
+
+=cut
+
+sub write { shift->{_context}->write(@_); }
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+This program is free software, you can redistribute it and/or modify 
+it under the same terms as Perl itself.
 
 =cut