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() },
24 sub output { shift->body(@_) }
30 Catalyst::Response - stores output responding to the current client request
36 $res->content_encoding;
49 This is the Catalyst Response class, which provides methods for responding to
50 the current client request. The appropriate L<Catalyst::Engine> for your environment
51 will turn the Catalyst::Response into a HTTP Response and return it to the client.
55 =head2 $res->body(<$text|$fh|$iohandle_object)
57 $c->response->body('Catalyst rocks!');
59 Sets or returns the output (text or binary data). If you are returning a large body,
60 you might want to use a L<IO::Handle> type of object (Something that implements the read method
61 in the same fashion), or a filehandle GLOB. Catalyst
62 will write it piece by piece into the response.
64 =head2 $res->content_encoding
66 Shortcut for $res->headers->content_encoding.
68 =head2 $res->content_length
70 Shortcut for $res->headers->content_length.
72 =head2 $res->content_type
74 Shortcut for $res->headers->content_type.
76 This value is typically set by your view or plugin. For example,
77 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
78 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
82 Returns a reference to a hash containing cookies to be set. The keys of the
83 hash are the cookies' names, and their corresponding values are hash
84 references used to construct a L<CGI::Cookie> object.
86 $c->response->cookies->{foo} = { value => '123' };
88 The keys of the hash reference on the right correspond to the L<CGI::Cookie>
89 parameters of the same name, except they are used without a leading dash.
90 Possible parameters are:
108 Shortcut for $res->headers->header.
112 Returns an L<HTTP::Headers> object, which can be used to set headers.
114 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
118 Alias for $res->body.
120 =head2 $res->redirect( $url, $status )
122 Causes the response to redirect to the specified URL. The default status is
125 $c->response->redirect( 'http://slashdot.org' );
126 $c->response->redirect( 'http://slashdot.org', 307 );
128 This is a convenience method that sets the Location header to the
129 redirect destination, and then sets the response status. You will
130 want to C< return; > or C< $c->detach() > to interrupt the normal
131 processing flow if you want the redirect to occur straight away.
139 my $location = shift;
140 my $status = shift || 302;
142 $self->location($location);
143 $self->status($status);
146 return $self->location;
149 =head2 $res->location
151 Sets or returns the HTTP 'Location'.
155 Sets or returns the HTTP status.
157 $c->response->status(404);
159 =head2 $res->write( $data )
161 Writes $data to the output stream.
167 =head2 $res->print( @data )
169 Prints @data to the output stream, separated by $,. This lets you pass
170 the response object to functions that want to write to an L<IO::Handle>.
178 defined $self->write($data) or return;
181 defined $self->write($,) or return;
182 defined $self->write($_) or return;
190 Catalyst Contributors, see Catalyst.pm
194 This program is free software, you can redistribute it and/or modify
195 it under the same terms as Perl itself.
199 __PACKAGE__->meta->make_immutable;