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 => 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,
+ 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
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
=head1 SYNOPSIS
$res = $c->response;
$res->body;
+ $res->code;
$res->content_encoding;
$res->content_length;
$res->content_type;
$res->cookies;
- $res->handle;
$res->header;
$res->headers;
$res->output;
$res->status;
$res->write;
-See also L<Catalyst::Application>.
-
=head1 DESCRIPTION
-This is the Catalyst Response class, which provides a set of accessors
-to response data.
+This is the Catalyst Response class, which provides methods for responding to
+the current client request. The appropriate L<Catalyst::Engine> for your environment
+will turn the Catalyst::Response into a HTTP Response and return it to the client.
=head1 METHODS
-=over 4
-
-=item $res->body($text)
+=head2 $res->body( $text | $fh | $iohandle_object )
$c->response->body('Catalyst rocks!');
-Contains the final output.
+Sets or returns the output (text or binary data). If you are returning a large body,
+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
-=item $res->content_encoding
+Shortcut for $res->headers->content_encoding.
-Shortcut to $res->headers->content_encoding
+=head2 $res->content_length
-=item $res->content_length
+Shortcut for $res->headers->content_length.
-Shortcut to $res->headers->content_length
+=head2 $res->content_type
-=item $res->content_type
+Shortcut for $res->headers->content_type.
-Shortcut to $res->headers->content_type
+This value is typically set by your view or plugin. For example,
+L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
+it found, while L<Catalyst::View::TT> defaults to C<text/html>.
-=item $res->cookies
+=head2 $res->cookies
-Returns a reference to a hash containing the cookies to be set.
+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<CGI::Simple::Cookie> object.
$c->response->cookies->{foo} = { value => '123' };
-=item $res->handle
+The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
+parameters of the same name, except they are used without a leading dash.
+Possible parameters are:
-Response IO handle.
+=over
-=cut
+=item value
-sub handle {
- my ( $self, $handle ) = @_;
-
- if ($handle) {
- $self->{handle} = $handle;
- }
- else {
- # Finalize headers if someone touches the output handle
- if ( $self->{_context} ) {
- $self->{_context}->finalize_headers;
- }
- }
-
- return $self->{handle};
-}
+=item expires
+
+=item domain
-=item $res->header
+=item path
+
+=item secure
+
+=item httponly
+
+=back
-Shortcut to $res->headers->header
+=head2 $res->header
-=item $res->headers
+Shortcut for $res->headers->header.
-Returns a L<HTTP::Headers> object containing the headers.
+=head2 $res->headers
+
+Returns an L<HTTP::Headers> object, which can be used to set headers.
$c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
-=item $res->output
+=head2 $res->output
-Shortcut to $res->body
+Alias for $res->body.
-=item $res->redirect( $url, $status )
+=head2 $res->redirect( $url, $status )
-Contains a location to redirect to.
+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.
+
+B<Note:> do not give a relative URL as $url, i.e: one that is not fully
+qualified (= C<http://...>, etc.) or that starts with a slash
+(= C</path/here>). 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 {
return $self->location;
}
-=item $res->status
+=head2 $res->location
+
+Sets or returns the HTTP 'Location'.
+
+=head2 $res->status
-Contains the HTTP status.
+Sets or returns the HTTP status.
$c->response->status(404);
-
-=item $res->write( $data )
+
+$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;
-=back
+ defined $self->write($data) or return;
-=head1 AUTHOR
+ for (@_) {
+ defined $self->write($,) or return;
+ defined $self->write($_) or return;
+ }
+ defined $self->write($\) or return;
-Sebastian Riedel, C<sri@cpan.org>
-Marcus Ramberg, C<mramberg@cpan.org>
+ 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
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff