1 package Catalyst::Response;
6 has cookies => (is => 'rw', default => sub { {} });
7 has body => (is => 'rw', default => '');
8 has location => (is => 'rw');
9 has status => (is => 'rw', default => 200);
10 has finalized_headers => (is => 'rw', default => 0);
13 handles => [qw(content_encoding content_length content_type header)],
14 default => sub { HTTP::Headers->new() },
23 sub output { shift->body(@_) }
29 Catalyst::Response - stores output responding to the current client request
35 $res->content_encoding;
48 This is the Catalyst Response class, which provides methods for responding to
49 the current client request. The appropriate L<Catalyst::Engine> for your environment
50 will turn the Catalyst::Response into a HTTP Response and return it to the client.
54 =head2 $res->body(<$text|$fh|$iofh_object)
56 $c->response->body('Catalyst rocks!');
58 Sets or returns the output (text or binary data). If you are returning a large body,
59 you might want to use a L<IO::FileHandle> type of object (Something that implements the read method
60 in the same fashion), or a filehandle GLOB. Catalyst
61 will write it piece by piece into the response.
63 =head2 $res->content_encoding
65 Shortcut for $res->headers->content_encoding.
67 =head2 $res->content_length
69 Shortcut for $res->headers->content_length.
71 =head2 $res->content_type
73 Shortcut for $res->headers->content_type.
75 This value is typically set by your view or plugin. For example,
76 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
77 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
81 Returns a reference to a hash containing cookies to be set. The keys of the
82 hash are the cookies' names, and their corresponding values are hash
83 references used to construct a L<CGI::Cookie> object.
85 $c->response->cookies->{foo} = { value => '123' };
87 The keys of the hash reference on the right correspond to the L<CGI::Cookie>
88 parameters of the same name, except they are used without a leading dash.
89 Possible parameters are:
107 Shortcut for $res->headers->header.
111 Returns an L<HTTP::Headers> object, which can be used to set headers.
113 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
117 Alias for $res->body.
119 =head2 $res->redirect( $url, $status )
121 Causes the response to redirect to the specified URL.
123 $c->response->redirect( 'http://slashdot.org' );
124 $c->response->redirect( 'http://slashdot.org', 307 );
132 my $location = shift;
133 my $status = shift || 302;
135 $self->location($location);
136 $self->status($status);
139 return $self->location;
142 =head2 $res->location
144 Sets or returns the HTTP 'Location'.
148 Sets or returns the HTTP status.
150 $c->response->status(404);
152 =head2 $res->write( $data )
154 Writes $data to the output stream.
158 sub write { shift->_context->write(@_); }
166 Sebastian Riedel, C<sri@cpan.org>
168 Marcus Ramberg, C<mramberg@cpan.org>
172 This program is free software, you can redistribute it and/or modify
173 it under the same terms as Perl itself.
177 __PACKAGE__->meta->make_immutable;