1 package Catalyst::Response;
5 use Moose::Util::TypeConstraints;
6 use namespace::autoclean;
8 with 'MooseX::Emulate::Class::Accessor::Fast';
13 writer => '_set_response_cb',
14 clearer => '_clear_response_cb',
15 predicate => '_has_response_cb',
18 subtype 'Catalyst::Engine::Types::Writer',
19 as duck_type([qw(write close)]);
23 isa => 'Catalyst::Engine::Types::Writer',
24 writer => '_set_writer',
25 clearer => '_clear_writer',
26 predicate => '_has_writer',
29 sub DEMOLISH { $_[0]->_writer->close if $_[0]->_has_writer }
31 has cookies => (is => 'rw', default => sub { {} });
32 has body => (is => 'rw', default => undef);
33 sub has_body { defined($_[0]->body) }
35 has location => (is => 'rw');
36 has status => (is => 'rw', default => 200);
37 has finalized_headers => (is => 'rw', default => 0);
40 isa => 'HTTP::Headers',
41 handles => [qw(content_encoding content_length content_type header)],
42 default => sub { HTTP::Headers->new() },
50 clearer => '_clear_context',
53 sub output { shift->body(@_) }
55 sub code { shift->status(@_) }
59 Catalyst::Response - stores output responding to the current client request
66 $res->content_encoding;
79 This is the Catalyst Response class, which provides methods for responding to
80 the current client request. The appropriate L<Catalyst::Engine> for your environment
81 will turn the Catalyst::Response into a HTTP Response and return it to the client.
85 =head2 $res->body( $text | $fh | $iohandle_object )
87 $c->response->body('Catalyst rocks!');
89 Sets or returns the output (text or binary data). If you are returning a large body,
90 you might want to use a L<IO::Handle> type of object (Something that implements the read method
91 in the same fashion), or a filehandle GLOB. Catalyst
92 will write it piece by piece into the response.
96 Predicate which returns true when a body has been set.
100 Alias for $res->status.
102 =head2 $res->content_encoding
104 Shortcut for $res->headers->content_encoding.
106 =head2 $res->content_length
108 Shortcut for $res->headers->content_length.
110 =head2 $res->content_type
112 Shortcut for $res->headers->content_type.
114 This value is typically set by your view or plugin. For example,
115 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
116 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
120 Returns a reference to a hash containing cookies to be set. The keys of the
121 hash are the cookies' names, and their corresponding values are hash
122 references used to construct a L<CGI::Simple::Cookie> object.
124 $c->response->cookies->{foo} = { value => '123' };
126 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
127 parameters of the same name, except they are used without a leading dash.
128 Possible parameters are:
148 Shortcut for $res->headers->header.
152 Returns an L<HTTP::Headers> object, which can be used to set headers.
154 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
158 Alias for $res->body.
160 =head2 $res->redirect( $url, $status )
162 Causes the response to redirect to the specified URL. The default status is
165 $c->response->redirect( 'http://slashdot.org' );
166 $c->response->redirect( 'http://slashdot.org', 307 );
168 This is a convenience method that sets the Location header to the
169 redirect destination, and then sets the response status. You will
170 want to C< return > or C<< $c->detach() >> to interrupt the normal
171 processing flow if you want the redirect to occur straight away.
173 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
174 qualified (= C<http://...>, etc.) or that starts with a slash
175 (= C</path/here>). While it may work, it is not guaranteed to do the right
176 thing and is not a standard behaviour. You may opt to use uri_for() or
177 uri_for_action() instead.
185 my $location = shift;
186 my $status = shift || 302;
188 $self->location($location);
189 $self->status($status);
192 return $self->location;
195 =head2 $res->location
197 Sets or returns the HTTP 'Location'.
201 Sets or returns the HTTP status.
203 $c->response->status(404);
205 $res->code is an alias for this, to match HTTP::Response->code.
207 =head2 $res->write( $data )
209 Writes $data to the output stream.
211 =head2 $res->print( @data )
213 Prints @data to the output stream, separated by $,. This lets you pass
214 the response object to functions that want to write to an L<IO::Handle>.
218 Ensures that the response is flushed and closed at the end of the
231 defined $self->write($data) or return;
234 defined $self->write($,) or return;
235 defined $self->write($_) or return;
237 defined $self->write($\) or return;
244 Catalyst Contributors, see Catalyst.pm
248 This library is free software. You can redistribute it and/or modify
249 it under the same terms as Perl itself.
253 __PACKAGE__->meta->make_immutable;