1 package Catalyst::Response;
5 has cookies => (is => 'rw');
6 has body => (is => 'rw');
7 has location => (is => 'rw');
8 has status => (is => 'rw');
11 handles => [qw(content_encoding content_length content_type header)],
19 sub output { shift->body(@_) }
25 Catalyst::Response - stores output responding to the current client request
31 $res->content_encoding;
44 This is the Catalyst Response class, which provides methods for responding to
45 the current client request. The appropriate L<Catalyst::Engine> for your environment
46 will turn the Catalyst::Response into a HTTP Response and return it to the client.
50 =head2 $res->body(<$text|$fh|$iofh_object)
52 $c->response->body('Catalyst rocks!');
54 Sets or returns the output (text or binary data). If you are returning a large body,
55 you might want to use a L<IO::FileHandle> type of object (Something that implements the read method
56 in the same fashion), or a filehandle GLOB. Catalyst
57 will write it piece by piece into the response.
59 =head2 $res->content_encoding
61 Shortcut for $res->headers->content_encoding.
63 =head2 $res->content_length
65 Shortcut for $res->headers->content_length.
67 =head2 $res->content_type
69 Shortcut for $res->headers->content_type.
71 This value is typically set by your view or plugin. For example,
72 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
73 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
77 Returns a reference to a hash containing cookies to be set. The keys of the
78 hash are the cookies' names, and their corresponding values are hash
79 references used to construct a L<CGI::Cookie> object.
81 $c->response->cookies->{foo} = { value => '123' };
83 The keys of the hash reference on the right correspond to the L<CGI::Cookie>
84 parameters of the same name, except they are used without a leading dash.
85 Possible parameters are:
103 Shortcut for $res->headers->header.
107 Returns an L<HTTP::Headers> object, which can be used to set headers.
109 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
113 Alias for $res->body.
115 =head2 $res->redirect( $url, $status )
117 Causes the response to redirect to the specified URL.
119 $c->response->redirect( 'http://slashdot.org' );
120 $c->response->redirect( 'http://slashdot.org', 307 );
128 my $location = shift;
129 my $status = shift || 302;
131 $self->location($location);
132 $self->status($status);
135 return $self->location;
138 =head2 $res->location
140 Sets or returns the HTTP 'Location'.
144 Sets or returns the HTTP status.
146 $c->response->status(404);
148 =head2 $res->write( $data )
150 Writes $data to the output stream.
154 sub write { shift->_context->write(@_); }
162 Sebastian Riedel, C<sri@cpan.org>
164 Marcus Ramberg, C<mramberg@cpan.org>
168 This program is free software, you can redistribute it and/or modify
169 it under the same terms as Perl itself.
173 __PACKAGE__->meta->make_immutable;