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=a6328d58686b49361a026ae02527732db29b3aee;hp=53d8ad8d9b309183721d5e2590de10af4e38495e;hb=b0ad47c12a21862b08d8e2942095065ac2f7edf2;hpb=dd8a0c31e0ba1056a350bcfadac07e5add83c6ad diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 53d8ad8..a6328d5 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -1,16 +1,34 @@ 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(@_) } + +sub code { shift->status(@_) } + +no Moose; =head1 NAME @@ -20,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; @@ -48,6 +67,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. @@ -76,7 +103,7 @@ 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 @@ -88,6 +115,8 @@ Possible parameters are: =item secure +=item httponly + =back =head2 $res->header @@ -112,6 +141,11 @@ 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 { @@ -128,19 +162,46 @@ sub redirect { return $self->location; } +=head2 $res->location + +Sets or returns the HTTP 'Location'. + =head2 $res->status 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; + + for (@_) { + defined $self->write($,) or return; + defined $self->write($_) or return; + } + + return 1; +} =head1 AUTHORS @@ -148,9 +209,11 @@ 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 +__PACKAGE__->meta->make_immutable; + 1;