package Catalyst::Response;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
-__PACKAGE__->mk_accessors(qw/cookies body headers redirect status/);
+has cookies => (is => 'rw');
+has body => (is => 'rw');
+has location => (is => 'rw');
+has status => (is => 'rw');
+has headers => (
+ is => 'rw',
+ handles => [qw(content_encoding content_length content_type header)],
+);
-*output = \&body;
+has _context => (
+ is => 'rw',
+ weak_ref => 1,
+);
-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(@_) }
+sub output { shift->body(@_) }
+
+no Moose;
=head1 NAME
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
=head1 SYNOPSIS
- $resp = $c->response;
- $resp->body;
- $resp->content_encoding;
- $resp->content_length;
- $resp->content_type;
- $resp->cookies;
- $resp->header;
- $resp->headers;
- $resp->output;
- $resp->redirect;
- $resp->status;
-
-See also L<Catalyst::Application>.
+ $res = $c->response;
+ $res->body;
+ $res->content_encoding;
+ $res->content_length;
+ $res->content_type;
+ $res->cookies;
+ $res->header;
+ $res->headers;
+ $res->output;
+ $res->redirect;
+ $res->status;
+ $res->write;
=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 $resp->body($text)
+=head2 $res->body(<$text|$fh|$iofh_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::FileHandle> 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->content_encoding
-=item $resp->content_encoding
+Shortcut for $res->headers->content_encoding.
-Shortcut to $resp->headers->content_encoding
+=head2 $res->content_length
-=item $resp->content_length
+Shortcut for $res->headers->content_length.
-Shortcut to $resp->headers->content_length
+=head2 $res->content_type
-=item $resp->content_type
+Shortcut for $res->headers->content_type.
-Shortcut to $resp->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 $resp->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::Cookie> object.
$c->response->cookies->{foo} = { value => '123' };
-=item $resp->header
+The keys of the hash reference on the right correspond to the L<CGI::Cookie>
+parameters of the same name, except they are used without a leading dash.
+Possible parameters are:
-Shortcut to $resp->headers->header
+=over
-=item $resp->headers
+=item value
-Returns a L<HTTP::Headers> object containing the headers.
+=item expires
+
+=item domain
+
+=item path
+
+=item secure
+
+=back
+
+=head2 $res->header
+
+Shortcut for $res->headers->header.
+
+=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 $resp->output
+=head2 $res->output
+
+Alias for $res->body.
-Shortcut to $resp->body
+=head2 $res->redirect( $url, $status )
-=item $resp->redirect($url)
+Causes the response to redirect to the specified URL.
-Contains a location to redirect to.
+ $c->response->redirect( 'http://slashdot.org' );
+ $c->response->redirect( 'http://slashdot.org', 307 );
- $c->response->redirect('http://slashdot.org');
+=cut
-=item status
+sub redirect {
+ my $self = shift;
-Contains the HTTP status.
+ if (@_) {
+ my $location = shift;
+ my $status = shift || 302;
+
+ $self->location($location);
+ $self->status($status);
+ }
+
+ 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);
+
+=head2 $res->write( $data )
-=back
+Writes $data to the output stream.
-=head1 AUTHOR
+=cut
+
+sub write { shift->_context->write(@_); }
+
+=head2 meta
+
+Provided by Moose
+
+=head1 AUTHORS
Sebastian Riedel, C<sri@cpan.org>
+
Marcus Ramberg, C<mramberg@cpan.org>
=head1 COPYRIGHT
=cut
+__PACKAGE__->meta->make_immutable;
+
1;
projects / catagits/Catalyst-Runtime.git / blobdiff