1 package Catalyst::Response;
6 with 'MooseX::Emulate::Class::Accessor::Fast';
8 has cookies => (is => 'rw', default => sub { {} });
9 has body => (is => 'rw', default => '');
10 has location => (is => 'rw');
11 has status => (is => 'rw', default => 200);
12 has finalized_headers => (is => 'rw', default => 0);
15 handles => [qw(content_encoding content_length content_type header)],
16 default => sub { HTTP::Headers->new() },
26 sub output { shift->body(@_) }
32 Catalyst::Response - stores output responding to the current client request
38 $res->content_encoding;
51 This is the Catalyst Response class, which provides methods for responding to
52 the current client request. The appropriate L<Catalyst::Engine> for your environment
53 will turn the Catalyst::Response into a HTTP Response and return it to the client.
57 =head2 $res->body(<$text|$fh|$iohandle_object)
59 $c->response->body('Catalyst rocks!');
61 Sets or returns the output (text or binary data). If you are returning a large body,
62 you might want to use a L<IO::Handle> type of object (Something that implements the read method
63 in the same fashion), or a filehandle GLOB. Catalyst
64 will write it piece by piece into the response.
66 =head2 $res->content_encoding
68 Shortcut for $res->headers->content_encoding.
70 =head2 $res->content_length
72 Shortcut for $res->headers->content_length.
74 =head2 $res->content_type
76 Shortcut for $res->headers->content_type.
78 This value is typically set by your view or plugin. For example,
79 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
80 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
84 Returns a reference to a hash containing cookies to be set. The keys of the
85 hash are the cookies' names, and their corresponding values are hash
86 references used to construct a L<CGI::Cookie> object.
88 $c->response->cookies->{foo} = { value => '123' };
90 The keys of the hash reference on the right correspond to the L<CGI::Cookie>
91 parameters of the same name, except they are used without a leading dash.
92 Possible parameters are:
110 Shortcut for $res->headers->header.
114 Returns an L<HTTP::Headers> object, which can be used to set headers.
116 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
120 Alias for $res->body.
122 =head2 $res->redirect( $url, $status )
124 Causes the response to redirect to the specified URL. The default status is
127 $c->response->redirect( 'http://slashdot.org' );
128 $c->response->redirect( 'http://slashdot.org', 307 );
130 This is a convenience method that sets the Location header to the
131 redirect destination, and then sets the response status. You will
132 want to C< return; > or C< $c->detach() > to interrupt the normal
133 processing flow if you want the redirect to occur straight away.
141 my $location = shift;
142 my $status = shift || 302;
144 $self->location($location);
145 $self->status($status);
148 return $self->location;
151 =head2 $res->location
153 Sets or returns the HTTP 'Location'.
157 Sets or returns the HTTP status.
159 $c->response->status(404);
161 =head2 $res->write( $data )
163 Writes $data to the output stream.
169 =head2 $res->print( @data )
171 Prints @data to the output stream, separated by $,. This lets you pass
172 the response object to functions that want to write to an L<IO::Handle>.
180 defined $self->write($data) or return;
183 defined $self->write($,) or return;
184 defined $self->write($_) or return;
192 Catalyst Contributors, see Catalyst.pm
196 This program is free software, you can redistribute it and/or modify
197 it under the same terms as Perl itself.
201 __PACKAGE__->meta->make_immutable;