X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=8aa9b22fd43d4edeba07d289487702cb14f8466c;hb=7a7ac23cbfaba1c66a454132313ceb7e885ab98b;hp=e0d1a3bc474f5231d17bcdc126e5385f11e41f81;hpb=73a525669951287e96f363365cacfc3467f17b39;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index e0d1a3b..8aa9b22 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -8,80 +8,97 @@ __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(@_)           }
+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
 
-    $resp = $c->response;
-    $resp->body;
-    $resp->content_encoding;
-    $resp->content_length;
-    $resp->content_type;
-    $resp->cookies;
-    $resp->header;
-    $resp->headers;
-    $resp->output;
-    $resp->redirect;
-    $resp->status;
-
-See also 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
 
-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.
 
 =head1 METHODS
 
-=over 4
-
-=item $resp->body($text)
+=head2 $res->body($text)
 
     $c->response->body('Catalyst rocks!');
 
-Contains the final output.
+Sets or returns the output (text or binary data).
 
-=item $resp->content_encoding
+=head2 $res->content_encoding
 
-Shortcut to $resp->headers->content_encoding
+Shortcut for $res->headers->content_encoding.
 
-=item $resp->content_length
+=head2 $res->content_length
 
-Shortcut to $resp->headers->content_length
+Shortcut for $res->headers->content_length.
 
-=item $resp->content_type
+=head2 $res->content_type
 
-Shortcut to $resp->headers->content_type
+Shortcut for $res->headers->content_type.
 
-=item $resp->cookies
+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>.
 
-Returns a reference to a hash containing the cookies to be set.
+=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' };
 
-=item $resp->header
+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:
+
+=head2 value
+
+=head2 expires
+
+=head2 domain
+
+=head2 path
+
+=head2 secure
 
-Shortcut to $resp->headers->header
+=head2 $res->header
 
-=item $resp->headers
+Shortcut for $res->headers->header.
 
-Returns a L<HTTP::Headers> object containing the headers.
+=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 $resp->output
+=head2 $res->output
 
-Shortcut to $resp->body
+Alias for $res->body.
 
-=item $resp->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 );
@@ -90,8 +107,8 @@ Contains a location to redirect to.
 
 sub redirect {
     my $self = shift;
-    
-    if ( @_ ) {
+
+    if (@_) {
         my $location = shift;
         my $status   = shift || 302;
 
@@ -102,17 +119,24 @@ sub redirect {
     return $self->location;
 }
 
-=item status
+=head2 $res->status
 
-Contains the HTTP status.
+Sets or returns the HTTP status.
 
     $c->response->status(404);
+    
+=head2 $res->write( $data )
 
-=back
+Writes $data to the output stream.
 
-=head1 AUTHOR
+=cut
+
+sub write { shift->{_context}->write(@_); }
+
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Marcus Ramberg, C<mramberg@cpan.org>
 
 =head1 COPYRIGHT