X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=8c5cc504d1aa23f38e1c1a51675f959ad28889c8;hb=b99ff5d87e80f13652bf374e2ce8f10c7156ac6e;hp=ff463981af53cba375725b0124f541d6ff004763;hpb=b5ecfcf07b8ffe7e9984f0279c8781ce51c6ac6a;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index ff46398..8c5cc50 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -1,16 +1,29 @@
 package Catalyst::Response;
 
-use strict;
-use base 'Class::Accessor::Fast';
-
-__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(@_) }
+use Moose;
+use HTTP::Headers;
+
+has cookies   => (is => 'rw', default => sub { {} });
+has body      => (is => 'rw', default => '');
+has location  => (is => 'rw');
+has status    => (is => 'rw', default => 200);
+has finalized_headers => (is => 'rw', default => 0);
+has headers   => (
+  is      => 'rw',
+  handles => [qw(content_encoding content_length content_type header)],
+  default => sub { HTTP::Headers->new() },
+  required => 1,
+  lazy => 1,
+);
+has _context => (
+  is => 'rw',
+  weak_ref => 1,
+  handles => ['write'],
+);
+
+sub output { shift->body(@_) }
+
+no Moose;
 
 =head1 NAME
 
@@ -34,15 +47,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|$iohandle_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::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
 
@@ -56,6 +73,10 @@ Shortcut for $res->headers->content_length.
 
 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
@@ -68,15 +89,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
+
+=item expires
 
-=head2 expires
+=item domain
 
-=head2 domain
+=item path
 
-=head2 path
+=item secure
 
-=head2 secure
+=back
 
 =head2 $res->header
 
@@ -94,11 +119,17 @@ Alias for $res->body.
 
 =head2 $res->redirect( $url, $status )
 
-Causes the response to redirect to the specified URL.
+Causes the response to redirect to the specified URL. The default status is
+C<302>.
 
     $c->response->redirect( 'http://slashdot.org' );
     $c->response->redirect( 'http://slashdot.org', 307 );
 
+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.
+
 =cut
 
 sub redirect {
@@ -115,6 +146,10 @@ sub redirect {
     return $self->location;
 }
 
+=head2 $res->location
+
+Sets or returns the HTTP 'Location'.
+
 =head2 $res->status
 
 Sets or returns the HTTP status.
@@ -125,15 +160,34 @@ Sets or returns the HTTP status.
 
 Writes $data to the output stream.
 
+=head2 meta
+
+Provided by Moose
+
+=head2 $res->print( @data )
+
+Prints @data to the output stream, separated by $,.  This lets you pass
+the response object to functions that want to write to an L<IO::Handle>.
+
 =cut
 
-sub write { shift->{_context}->write(@_); }
+sub print {
+    my $self = shift;
+    my $data = shift;
 
-=head1 AUTHORS
+    defined $self->write($data) or return;
+
+    for (@_) {
+        defined $self->write($,) or return;
+        defined $self->write($_) or return;
+    }
+    
+    return 1;
+}
 
-Sebastian Riedel, C<sri@cpan.org>
+=head1 AUTHORS
 
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
@@ -142,4 +196,6 @@ it under the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;