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=3203b2d1af9562be086ab54b54127a101c71aca4;hp=a6fbf0f1a750653f0ad113148fe568413cbae061;hb=ae29b412955743885e80350085167b54b69672da;hpb=ac965e92078c3aee85d0d5db153c728cd26cf182

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index a6fbf0f..3203b2d 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -1,20 +1,36 @@
 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;
+
+with 'MooseX::Emulate::Class::Accessor::Fast';
+
+has cookies   => (is => 'rw', default => sub { {} });
+has body      => (is => 'rw', default => '', lazy => 1, predicate => 'has_body');
+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'],
+  clearer => '_clear_context',
+);
+
+sub output { shift->body(@_) }
+
+no Moose;
 
 =head1 NAME
 
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
 
 =head1 SYNOPSIS
 
@@ -31,49 +47,56 @@ 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|$iohandle_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::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.
 
-=item $res->content_encoding
+=head2 $res->has_body
 
-Shortcut to $res->headers->content_encoding
+Predicate which returns true when a body has been set.
 
-=item $res->content_length
+=head2 $res->content_encoding
 
-Shortcut to $res->headers->content_length
+Shortcut for $res->headers->content_encoding.
 
-=item $res->content_type
+=head2 $res->content_length
 
-Shortcut to $res->headers->content_type
+Shortcut for $res->headers->content_length.
 
-=item $res->cookies
+=head2 $res->content_type
 
-Returns a reference to a hash containing the cookies to be set. The keys of the
-hash are the cookies' names, and their corresponding values are hash references
-used to construct L<CGI::Cookie> object.
+Shortcut for $res->headers->content_type.
 
-    $c->response->cookies->{foo} = { value => '123' };
+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>.
 
-The values correspond to the L<CGI::Cookie> parameters of the same name, except
-they are used without a leading dash.
+=head2 $res->cookies
 
-The proxied parameters are
+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.
 
-=over 4
+    $c->response->cookies->{foo} = { value => '123' };
+
+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
 
@@ -85,31 +108,35 @@ The proxied parameters are
 
 =item secure
 
-=item 
-
 =back
 
-=item $res->header
+=head2 $res->header
 
-Shortcut to $res->headers->header
+Shortcut for $res->headers->header.
 
-=item $res->headers
+=head2 $res->headers
 
-Returns a L<HTTP::Headers> object containing the 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. 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 {
@@ -126,26 +153,48 @@ sub redirect {
     return $self->location;
 }
 
-=item $res->status
+=head2 $res->location
+
+Sets or returns the HTTP 'Location'.
 
-Contains the HTTP status.
+=head2 $res->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.
 
+=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;
+
+    defined $self->write($data) or return;
 
-=back
+    for (@_) {
+        defined $self->write($,) or return;
+        defined $self->write($_) or return;
+    }
+    
+    return 1;
+}
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
@@ -154,4 +203,6 @@ it under the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;