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=5f49df75452dcc5ef8d2973324ff60022e4b9280;hp=ad16cdb61a5cd8b79afb36f9c12ebeaa565098df;hb=ddcd2fc4728111853841078cc5d9a117b993ea96;hpb=b21bc4683a90d1d69b295b51472b95b269fb0ad5 diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index ad16cdb..5f49df7 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -2,16 +2,42 @@ package Catalyst::Response; use Moose; use HTTP::Headers; +use Moose::Util::TypeConstraints; +use namespace::autoclean; with 'MooseX::Emulate::Class::Accessor::Fast'; +has _response_cb => ( + is => 'ro', + isa => 'CodeRef', + writer => '_set_response_cb', + clearer => '_clear_response_cb', + predicate => '_has_response_cb', +); + +subtype 'Catalyst::Engine::Types::Writer', + as duck_type([qw(write close)]); + +has _writer => ( + is => 'ro', + isa => 'Catalyst::Engine::Types::Writer', + writer => '_set_writer', + clearer => '_clear_writer', + predicate => '_has_writer', +); + +sub DEMOLISH { $_[0]->_writer->close if $_[0]->_has_writer } + has cookies => (is => 'rw', default => sub { {} }); -has body => (is => 'rw', default => '', lazy => 1, predicate => 'has_body'); +has body => (is => 'rw', default => undef); +sub has_body { defined($_[0]->body) } + has location => (is => 'rw'); has status => (is => 'rw', default => 200); has finalized_headers => (is => 'rw', default => 0); has headers => ( is => 'rw', + isa => 'HTTP::Headers', handles => [qw(content_encoding content_length content_type header)], default => sub { HTTP::Headers->new() }, required => 1, @@ -28,8 +54,6 @@ sub output { shift->body(@_) } sub code { shift->status(@_) } -no Moose; - =head1 NAME Catalyst::Response - stores output responding to the current client request @@ -58,7 +82,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!'); @@ -95,15 +119,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 @@ -143,9 +167,15 @@ 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. +B do not give a relative URL as $url, i.e: one that is not fully +qualified (= C, etc.) or that starts with a slash +(= C). While it may work, it is not guaranteed to do the right +thing and is not a standard behaviour. You may opt to use uri_for() or +uri_for_action() instead. + =cut sub redirect { @@ -173,20 +203,25 @@ 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. +=head2 DEMOLISH + +Ensures that the response is flushed and closed at the end of the +request. + +=head2 meta + +Provided by Moose + =cut sub print { @@ -199,7 +234,8 @@ sub print { defined $self->write($,) or return; defined $self->write($_) or return; } - + defined $self->write($\) or return; + return 1; } @@ -209,7 +245,7 @@ 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