Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst::Response; |
2 | |
3 | use strict; |
4 | use base 'Class::Accessor::Fast'; |
5 | |
73a52566 |
6 | __PACKAGE__->mk_accessors(qw/cookies body headers location status/); |
e060fe05 |
7 | |
8 | *output = \&body; |
fc7ec1d9 |
9 | |
f7e4e231 |
10 | sub content_encoding { shift->headers->content_encoding(@_) } |
fbcc39ad |
11 | sub content_length { shift->headers->content_length(@_) } |
12 | sub content_type { shift->headers->content_type(@_) } |
13 | sub header { shift->headers->header(@_) } |
f7e4e231 |
14 | |
fc7ec1d9 |
15 | =head1 NAME |
16 | |
910410b8 |
17 | Catalyst::Response - stores output responding to the current client request |
fc7ec1d9 |
18 | |
19 | =head1 SYNOPSIS |
20 | |
fbcc39ad |
21 | $res = $c->response; |
22 | $res->body; |
23 | $res->content_encoding; |
24 | $res->content_length; |
25 | $res->content_type; |
26 | $res->cookies; |
fbcc39ad |
27 | $res->header; |
28 | $res->headers; |
29 | $res->output; |
30 | $res->redirect; |
31 | $res->status; |
32 | $res->write; |
b22c6668 |
33 | |
fc7ec1d9 |
34 | =head1 DESCRIPTION |
35 | |
910410b8 |
36 | This is the Catalyst Response class, which provides methods for responding to |
37 | the current client request. |
b22c6668 |
38 | |
39 | =head1 METHODS |
fc7ec1d9 |
40 | |
b5ecfcf0 |
41 | =head2 $res->body($text) |
e060fe05 |
42 | |
43 | $c->response->body('Catalyst rocks!'); |
06e1b616 |
44 | |
910410b8 |
45 | Sets or returns the output (text or binary data). |
06e1b616 |
46 | |
b5ecfcf0 |
47 | =head2 $res->content_encoding |
b5176d9e |
48 | |
910410b8 |
49 | Shortcut for $res->headers->content_encoding. |
b5176d9e |
50 | |
b5ecfcf0 |
51 | =head2 $res->content_length |
b5176d9e |
52 | |
910410b8 |
53 | Shortcut for $res->headers->content_length. |
b5176d9e |
54 | |
b5ecfcf0 |
55 | =head2 $res->content_type |
b5176d9e |
56 | |
910410b8 |
57 | Shortcut for $res->headers->content_type. |
b5176d9e |
58 | |
87e9f9ab |
59 | This value is typically set by your view or plugin. For example, |
60 | L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file |
61 | it found, while L<Catalyst::View::TT> defaults to C<text/html>. |
62 | |
b5ecfcf0 |
63 | =head2 $res->cookies |
fc7ec1d9 |
64 | |
910410b8 |
65 | Returns a reference to a hash containing cookies to be set. The keys of the |
66 | hash are the cookies' names, and their corresponding values are hash |
67 | references used to construct a L<CGI::Cookie> object. |
fc7ec1d9 |
68 | |
69 | $c->response->cookies->{foo} = { value => '123' }; |
70 | |
910410b8 |
71 | The keys of the hash reference on the right correspond to the L<CGI::Cookie> |
72 | parameters of the same name, except they are used without a leading dash. |
73 | Possible parameters are: |
ac965e92 |
74 | |
b5ecfcf0 |
75 | =head2 value |
ac965e92 |
76 | |
b5ecfcf0 |
77 | =head2 expires |
ac965e92 |
78 | |
b5ecfcf0 |
79 | =head2 domain |
ac965e92 |
80 | |
b5ecfcf0 |
81 | =head2 path |
ac965e92 |
82 | |
b5ecfcf0 |
83 | =head2 secure |
ac965e92 |
84 | |
b5ecfcf0 |
85 | =head2 $res->header |
fbcc39ad |
86 | |
910410b8 |
87 | Shortcut for $res->headers->header. |
fbcc39ad |
88 | |
b5ecfcf0 |
89 | =head2 $res->headers |
fc7ec1d9 |
90 | |
910410b8 |
91 | Returns an L<HTTP::Headers> object, which can be used to set headers. |
fc7ec1d9 |
92 | |
93 | $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); |
94 | |
b5ecfcf0 |
95 | =head2 $res->output |
fc7ec1d9 |
96 | |
910410b8 |
97 | Alias for $res->body. |
fc7ec1d9 |
98 | |
b5ecfcf0 |
99 | =head2 $res->redirect( $url, $status ) |
fc7ec1d9 |
100 | |
910410b8 |
101 | Causes the response to redirect to the specified URL. |
fc7ec1d9 |
102 | |
73a52566 |
103 | $c->response->redirect( 'http://slashdot.org' ); |
104 | $c->response->redirect( 'http://slashdot.org', 307 ); |
105 | |
106 | =cut |
107 | |
108 | sub redirect { |
109 | my $self = shift; |
fbcc39ad |
110 | |
111 | if (@_) { |
73a52566 |
112 | my $location = shift; |
f1bbebac |
113 | my $status = shift || 302; |
73a52566 |
114 | |
115 | $self->location($location); |
116 | $self->status($status); |
117 | } |
118 | |
119 | return $self->location; |
120 | } |
fc7ec1d9 |
121 | |
b5ecfcf0 |
122 | =head2 $res->status |
fc7ec1d9 |
123 | |
910410b8 |
124 | Sets or returns the HTTP status. |
fc7ec1d9 |
125 | |
126 | $c->response->status(404); |
fbcc39ad |
127 | |
b5ecfcf0 |
128 | =head2 $res->write( $data ) |
fbcc39ad |
129 | |
130 | Writes $data to the output stream. |
131 | |
132 | =cut |
133 | |
134 | sub write { shift->{_context}->write(@_); } |
fc7ec1d9 |
135 | |
910410b8 |
136 | =head1 AUTHORS |
fc7ec1d9 |
137 | |
138 | Sebastian Riedel, C<sri@cpan.org> |
910410b8 |
139 | |
61b1e958 |
140 | Marcus Ramberg, C<mramberg@cpan.org> |
fc7ec1d9 |
141 | |
142 | =head1 COPYRIGHT |
143 | |
61b1e958 |
144 | This program is free software, you can redistribute it and/or modify |
145 | it under the same terms as Perl itself. |
fc7ec1d9 |
146 | |
147 | =cut |
148 | |
149 | 1; |