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=595decb4cbdb06836ed53c90f32041aa4fd040d0;hp=3b57cab8dedd522a141ac0682988846366a8e7ad;hb=2bf074abee817f84daec2a06822f9dcdb881843f;hpb=e5ecd5bc38bac3e2fcfaf643ea2a4c6ab46d7e57 diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 3b57cab..595decb 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -1,23 +1,40 @@ 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', + 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'); +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 +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; @@ -47,15 +65,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 type of object (Something that implements the read method +you might want to use a L 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. @@ -96,6 +122,8 @@ Possible parameters are: =item secure +=item httponly + =back =head2 $res->header @@ -114,11 +142,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 { @@ -145,27 +179,44 @@ 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. + =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 - -Marcus Ramberg, C +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