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