X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=f268aefbee830273aaedc6d3c1859b86cb30e983;hb=fb34eb9c063c53abd061d260a30f0ca7c57a0833;hp=545341d90d919333d409da82ab2d9ea5d8d5fe4a;hpb=2f3812528068bc1d9f7840067f0c03d36cd47e6d;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 545341d..f268aef 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -3,8 +3,17 @@ package Catalyst::Response; use Moose; use HTTP::Headers; +with 'MooseX::Emulate::Class::Accessor::Fast'; + has cookies => (is => 'rw', default => sub { {} }); -has body => (is => 'rw', default => ''); +has body => (is => 'rw', default => '', lazy => 1, predicate => 'has_body', + clearer => '_clear_body' +); +after 'body' => sub { # If someone assigned undef, clear the body so we get '' + if (scalar(@_) == 2 && !defined($_[1])) { + $_[0]->_clear_body; + } +}; has location => (is => 'rw'); has status => (is => 'rw', default => 200); has finalized_headers => (is => 'rw', default => 0); @@ -19,10 +28,13 @@ has _context => ( is => 'rw', weak_ref => 1, handles => ['write'], + clearer => '_clear_context', ); sub output { shift->body(@_) } +sub code { shift->status(@_) } + no Moose; =head1 NAME @@ -33,6 +45,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; @@ -52,7 +65,7 @@ will turn the Catalyst::Response into a HTTP Response and return it to the clien =head1 METHODS -=head2 $res->body(<$text|$fh|$iohandle_object) +=head2 $res->body( $text | $fh | $iohandle_object ) $c->response->body('Catalyst rocks!'); @@ -61,6 +74,14 @@ you might want to use a L type of object (Something that implements 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. @@ -81,15 +102,15 @@ it found, while L defaults to C. 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 object. +references used to construct a L object. $c->response->cookies->{foo} = { value => '123' }; -The keys of the hash reference on the right correspond to the L +The keys of the hash reference on the right correspond to the L parameters of the same name, except they are used without a leading dash. Possible parameters are: -=over +=over =item value @@ -101,6 +122,8 @@ Possible parameters are: =item secure +=item httponly + =back =head2 $res->header @@ -127,7 +150,7 @@ C<302>. 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 +want to C< return > or C<< $c->detach() >> to interrupt the normal processing flow if you want the redirect to occur straight away. =cut @@ -155,7 +178,9 @@ 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. @@ -164,13 +189,34 @@ Writes $data to the output stream. 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. + +=cut + +sub print { + my $self = shift; + my $data = shift; + + defined $self->write($data) or return; + + for (@_) { + defined $self->write($,) or return; + defined $self->write($_) or return; + } + + return 1; +} + =head1 AUTHORS 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