X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=877f8c967daea14e14ea0fe987a6155f63bf9a23;hp=6f8b5c66ea0d5ea75ca7ab677c1669a5d8216bd8;hb=25f55123b7c0b520eb166890bf47f1f3217200af;hpb=fbcc39ad23f2bbecf5d84c9ba581e6af86fcd460

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index 6f8b5c6..877f8c9 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -14,7 +14,7 @@ sub header           { shift->headers->header(@_) }
 
 =head1 NAME
 
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
 
 =head1 SYNOPSIS
 
@@ -24,7 +24,6 @@ Catalyst::Response - Catalyst Response Class
     $res->content_length;
     $res->content_type;
     $res->cookies;
-    $res->handle;
     $res->header;
     $res->headers;
     $res->output;
@@ -32,80 +31,82 @@ Catalyst::Response - Catalyst Response Class
     $res->status;
     $res->write;
 
-See also L<Catalyst::Application>.
-
 =head1 DESCRIPTION
 
-This is the Catalyst Response class, which provides a set of accessors
-to response data.
+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
 
-=over 4
-
-=item $res->body($text)
+=head2 $res->body(<$text|$fh|$iofh_object)
 
     $c->response->body('Catalyst rocks!');
 
-Contains the final output.
+Sets or returns the output (text or binary data). If you are returning a large body,
+you might want to use a L<IO::FileHandle> 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
 
-=item $res->content_encoding
+Shortcut for $res->headers->content_encoding.
 
-Shortcut to $res->headers->content_encoding
+=head2 $res->content_length
 
-=item $res->content_length
+Shortcut for $res->headers->content_length.
 
-Shortcut to $res->headers->content_length
+=head2 $res->content_type
 
-=item $res->content_type
+Shortcut for $res->headers->content_type.
 
-Shortcut to $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>.
 
-=item $res->cookies
+=head2 $res->cookies
 
-Returns a reference to a hash containing the cookies to be set.
+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' };
 
-=item $res->handle
+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:
 
-Response IO handle.
+=over 
 
-=cut
+=item value
 
-sub handle {
-    my ( $self, $handle ) = @_;
-    
-    if ($handle) { 
-        $self->{handle} = $handle;
-    }
-    else {
-        # Finalize headers if someone touches the output handle
-        if ( $self->{_context} ) {
-            $self->{_context}->finalize_headers;
-        }
-    }
-    
-    return $self->{handle};
-}
+=item expires
 
-=item $res->header
+=item domain
 
-Shortcut to $res->headers->header
+=item path
 
-=item $res->headers
+=item secure
 
-Returns a L<HTTP::Headers> object containing the headers.
+=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 );
 
-=item $res->output
+=head2 $res->output
 
-Shortcut to $res->body
+Alias for $res->body.
 
-=item $res->redirect( $url, $status )
+=head2 $res->redirect( $url, $status )
 
-Contains a location to redirect to.
+Causes the response to redirect to the specified URL.
 
     $c->response->redirect( 'http://slashdot.org' );
     $c->response->redirect( 'http://slashdot.org', 307 );
@@ -126,13 +127,13 @@ sub redirect {
     return $self->location;
 }
 
-=item $res->status
+=head2 $res->status
 
-Contains the HTTP status.
+Sets or returns the HTTP status.
 
     $c->response->status(404);
     
-=item $res->write( $data )
+=head2 $res->write( $data )
 
 Writes $data to the output stream.
 
@@ -140,11 +141,10 @@ Writes $data to the output stream.
 
 sub write { shift->{_context}->write(@_); }
 
-=back
-
-=head1 AUTHOR
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Marcus Ramberg, C<mramberg@cpan.org>
 
 =head1 COPYRIGHT