Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst::Response; |
2 | |
059c085b |
3 | use Moose; |
6680c772 |
4 | use HTTP::Headers; |
fc7ec1d9 |
5 | |
6680c772 |
6 | has cookies => (is => 'rw', default => sub { {} }); |
7 | has body => (is => 'rw', default => ''); |
059c085b |
8 | has location => (is => 'rw'); |
6680c772 |
9 | has status => (is => 'rw', default => 200); |
10 | has finalized_headers => (is => 'rw', default => 0); |
059c085b |
11 | has headers => ( |
12 | is => 'rw', |
13 | handles => [qw(content_encoding content_length content_type header)], |
6680c772 |
14 | default => sub { HTTP::Headers->new() }, |
15 | required => 1, |
16 | lazy => 1, |
059c085b |
17 | ); |
059c085b |
18 | has _context => ( |
19 | is => 'rw', |
20 | weak_ref => 1, |
0fc2d522 |
21 | handles => ['write'], |
059c085b |
22 | ); |
fc7ec1d9 |
23 | |
059c085b |
24 | sub output { shift->body(@_) } |
25 | |
26 | no Moose; |
f7e4e231 |
27 | |
fc7ec1d9 |
28 | =head1 NAME |
29 | |
910410b8 |
30 | Catalyst::Response - stores output responding to the current client request |
fc7ec1d9 |
31 | |
32 | =head1 SYNOPSIS |
33 | |
fbcc39ad |
34 | $res = $c->response; |
35 | $res->body; |
36 | $res->content_encoding; |
37 | $res->content_length; |
38 | $res->content_type; |
39 | $res->cookies; |
fbcc39ad |
40 | $res->header; |
41 | $res->headers; |
42 | $res->output; |
43 | $res->redirect; |
44 | $res->status; |
45 | $res->write; |
b22c6668 |
46 | |
fc7ec1d9 |
47 | =head1 DESCRIPTION |
48 | |
910410b8 |
49 | This is the Catalyst Response class, which provides methods for responding to |
46372e65 |
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. |
b22c6668 |
52 | |
53 | =head1 METHODS |
fc7ec1d9 |
54 | |
2f381252 |
55 | =head2 $res->body(<$text|$fh|$iohandle_object) |
e060fe05 |
56 | |
57 | $c->response->body('Catalyst rocks!'); |
06e1b616 |
58 | |
46372e65 |
59 | Sets or returns the output (text or binary data). If you are returning a large body, |
2f381252 |
60 | you might want to use a L<IO::Handle> type of object (Something that implements the read method |
46372e65 |
61 | in the same fashion), or a filehandle GLOB. Catalyst |
62 | will write it piece by piece into the response. |
06e1b616 |
63 | |
b5ecfcf0 |
64 | =head2 $res->content_encoding |
b5176d9e |
65 | |
910410b8 |
66 | Shortcut for $res->headers->content_encoding. |
b5176d9e |
67 | |
b5ecfcf0 |
68 | =head2 $res->content_length |
b5176d9e |
69 | |
910410b8 |
70 | Shortcut for $res->headers->content_length. |
b5176d9e |
71 | |
b5ecfcf0 |
72 | =head2 $res->content_type |
b5176d9e |
73 | |
910410b8 |
74 | Shortcut for $res->headers->content_type. |
b5176d9e |
75 | |
87e9f9ab |
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>. |
79 | |
b5ecfcf0 |
80 | =head2 $res->cookies |
fc7ec1d9 |
81 | |
910410b8 |
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. |
fc7ec1d9 |
85 | |
86 | $c->response->cookies->{foo} = { value => '123' }; |
87 | |
910410b8 |
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: |
ac965e92 |
91 | |
ac5c933b |
92 | =over |
ac965e92 |
93 | |
71453caf |
94 | =item value |
ac965e92 |
95 | |
71453caf |
96 | =item expires |
ac965e92 |
97 | |
71453caf |
98 | =item domain |
ac965e92 |
99 | |
71453caf |
100 | =item path |
101 | |
102 | =item secure |
103 | |
104 | =back |
ac965e92 |
105 | |
b5ecfcf0 |
106 | =head2 $res->header |
fbcc39ad |
107 | |
910410b8 |
108 | Shortcut for $res->headers->header. |
fbcc39ad |
109 | |
b5ecfcf0 |
110 | =head2 $res->headers |
fc7ec1d9 |
111 | |
910410b8 |
112 | Returns an L<HTTP::Headers> object, which can be used to set headers. |
fc7ec1d9 |
113 | |
114 | $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); |
115 | |
b5ecfcf0 |
116 | =head2 $res->output |
fc7ec1d9 |
117 | |
910410b8 |
118 | Alias for $res->body. |
fc7ec1d9 |
119 | |
b5ecfcf0 |
120 | =head2 $res->redirect( $url, $status ) |
fc7ec1d9 |
121 | |
2f381252 |
122 | Causes the response to redirect to the specified URL. The default status is |
123 | C<302>. |
fc7ec1d9 |
124 | |
73a52566 |
125 | $c->response->redirect( 'http://slashdot.org' ); |
126 | $c->response->redirect( 'http://slashdot.org', 307 ); |
127 | |
2f381252 |
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. |
132 | |
73a52566 |
133 | =cut |
134 | |
135 | sub redirect { |
136 | my $self = shift; |
fbcc39ad |
137 | |
138 | if (@_) { |
73a52566 |
139 | my $location = shift; |
f1bbebac |
140 | my $status = shift || 302; |
73a52566 |
141 | |
142 | $self->location($location); |
143 | $self->status($status); |
144 | } |
145 | |
146 | return $self->location; |
147 | } |
fc7ec1d9 |
148 | |
059c085b |
149 | =head2 $res->location |
150 | |
151 | Sets or returns the HTTP 'Location'. |
152 | |
b5ecfcf0 |
153 | =head2 $res->status |
fc7ec1d9 |
154 | |
910410b8 |
155 | Sets or returns the HTTP status. |
fc7ec1d9 |
156 | |
157 | $c->response->status(404); |
ac5c933b |
158 | |
b5ecfcf0 |
159 | =head2 $res->write( $data ) |
fbcc39ad |
160 | |
161 | Writes $data to the output stream. |
162 | |
059c085b |
163 | =head2 meta |
164 | |
165 | Provided by Moose |
fc7ec1d9 |
166 | |
910410b8 |
167 | =head1 AUTHORS |
fc7ec1d9 |
168 | |
2f381252 |
169 | Catalyst Contributors, see Catalyst.pm |
fc7ec1d9 |
170 | |
171 | =head1 COPYRIGHT |
172 | |
ac5c933b |
173 | This program is free software, you can redistribute it and/or modify |
61b1e958 |
174 | it under the same terms as Perl itself. |
fc7ec1d9 |
175 | |
176 | =cut |
177 | |
e5ecd5bc |
178 | __PACKAGE__->meta->make_immutable; |
179 | |
fc7ec1d9 |
180 | 1; |