Cosmetic: removed trailing whitespace

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Response.pm

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index cb280dd..a6328d5 100644 (file)
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -1,23 +1,33 @@
 package Catalyst::Response;
 
 use Moose;
+use HTTP::Headers;
 
-has cookies   => (is => 'rw');
-has body      => (is => 'rw');
+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');
+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(@_) }
 
+sub code   { shift->status(@_) }
+
 no Moose;
 
 =head1 NAME
@@ -28,6 +38,7 @@ Catalyst::Response - stores output responding to the current client request
 
     $res = $c->response;
     $res->body;
+    $res->code;
     $res->content_encoding;
     $res->content_length;
     $res->content_type;
@@ -47,15 +58,23 @@ will turn the Catalyst::Response into a HTTP Response and return it to the clien
 
 =head1 METHODS
 
-=head2 $res->body(<$text|$fh|$iofh_object)
+=head2 $res->body(<$text|$fh|$iohandle_object)
 
     $c->response->body('Catalyst rocks!');
 
 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
+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->has_body
+
+Predicate which returns true when a body has been set.
+
+=head2 $res->code
+
+Alias for $res->status.
+
 =head2 $res->content_encoding
 
 Shortcut for $res->headers->content_encoding.
@@ -84,7 +103,7 @@ 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 
+=over
 
 =item value
 
@@ -96,6 +115,8 @@ Possible parameters are:
 
 =item secure
 
+=item httponly
+
 =back
 
 =head2 $res->header
@@ -114,11 +135,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 {
@@ -144,28 +171,45 @@ Sets or returns the HTTP 'Location'.
 Sets or returns the HTTP status.
 
     $c->response->status(404);
-    
+
+$res->code is an alias for this, to match HTTP::Response->code.
+
 =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;
 
-=head2 meta
+    for (@_) {
+        defined $self->write($,) or return;
+        defined $self->write($_) or return;
+    }
 
-Provided by Moose
+    return 1;
+}
 
 =head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
-
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify 
+This library is free software. You can redistribute it and/or modify
 it under the same terms as Perl itself.
 
 =cut