reverting (most of) the whitespace changes
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Response.pm
index 8aa9b22..cb280dd 100644 (file)
@@ -1,16 +1,24 @@
 package Catalyst::Response;
 
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
 
-__PACKAGE__->mk_accessors(qw/cookies body headers location status/);
+has cookies   => (is => 'rw');
+has body      => (is => 'rw');
+has location  => (is => 'rw');
+has status    => (is => 'rw');
+has headers   => (
+  is      => 'rw',
+  handles => [qw(content_encoding content_length content_type header)],
+);
 
-*output = \&body;
+has _context => (
+  is => 'rw',
+  weak_ref => 1,
+);
 
-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 output { shift->body(@_) }
+
+no Moose;
 
 =head1 NAME
 
@@ -34,15 +42,19 @@ Catalyst::Response - stores output responding to the current client request
 =head1 DESCRIPTION
 
 This is the Catalyst Response class, which provides methods for responding to
-the current client request.
+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)
+=head2 $res->body(<$text|$fh|$iofh_object)
 
     $c->response->body('Catalyst rocks!');
 
-Sets or returns the output (text or binary data).
+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
 
@@ -72,15 +84,19 @@ 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
+=over 
+
+=item value
 
-=head2 expires
+=item expires
 
-=head2 domain
+=item domain
 
-=head2 path
+=item path
 
-=head2 secure
+=item secure
+
+=back
 
 =head2 $res->header
 
@@ -119,6 +135,10 @@ sub redirect {
     return $self->location;
 }
 
+=head2 $res->location
+
+Sets or returns the HTTP 'Location'.
+
 =head2 $res->status
 
 Sets or returns the HTTP status.
@@ -131,7 +151,11 @@ Writes $data to the output stream.
 
 =cut
 
-sub write { shift->{_context}->write(@_); }
+sub write { shift->_context->write(@_); }
+
+=head2 meta
+
+Provided by Moose
 
 =head1 AUTHORS
 
@@ -146,4 +170,6 @@ it under the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;