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 | ||
17 | Catalyst::Response - Catalyst Response Class | |
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 | |
34 | See also L<Catalyst::Application>. | |
fc7ec1d9 | 35 | |
36 | =head1 DESCRIPTION | |
37 | ||
61b1e958 | 38 | This is the Catalyst Response class, which provides a set of accessors |
39 | to response data. | |
b22c6668 | 40 | |
41 | =head1 METHODS | |
fc7ec1d9 | 42 | |
b22c6668 | 43 | =over 4 |
fc7ec1d9 | 44 | |
fbcc39ad | 45 | =item $res->body($text) |
e060fe05 | 46 | |
47 | $c->response->body('Catalyst rocks!'); | |
06e1b616 | 48 | |
e060fe05 | 49 | Contains the final output. |
06e1b616 | 50 | |
fbcc39ad | 51 | =item $res->content_encoding |
b5176d9e | 52 | |
fbcc39ad | 53 | Shortcut to $res->headers->content_encoding |
b5176d9e | 54 | |
fbcc39ad | 55 | =item $res->content_length |
b5176d9e | 56 | |
fbcc39ad | 57 | Shortcut to $res->headers->content_length |
b5176d9e | 58 | |
fbcc39ad | 59 | =item $res->content_type |
b5176d9e | 60 | |
fbcc39ad | 61 | Shortcut to $res->headers->content_type |
b5176d9e | 62 | |
fbcc39ad | 63 | =item $res->cookies |
fc7ec1d9 | 64 | |
ac965e92 | 65 | Returns a reference to a hash containing the cookies to be set. The keys of the |
66 | hash are the cookies' names, and their corresponding values are hash references | |
67 | used to construct L<CGI::Cookie> object. | |
fc7ec1d9 | 68 | |
69 | $c->response->cookies->{foo} = { value => '123' }; | |
70 | ||
ac965e92 | 71 | The values correspond to the L<CGI::Cookie> parameters of the same name, except |
72 | they are used without a leading dash. | |
73 | ||
74 | The proxied parameters are | |
75 | ||
76 | =over 4 | |
77 | ||
78 | =item value | |
79 | ||
80 | =item expires | |
81 | ||
82 | =item domain | |
83 | ||
84 | =item path | |
85 | ||
86 | =item secure | |
87 | ||
88 | =item | |
89 | ||
90 | =back | |
91 | ||
fbcc39ad | 92 | =item $res->header |
93 | ||
94 | Shortcut to $res->headers->header | |
95 | ||
96 | =item $res->headers | |
fc7ec1d9 | 97 | |
98 | Returns a L<HTTP::Headers> object containing the headers. | |
99 | ||
100 | $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); | |
101 | ||
fbcc39ad | 102 | =item $res->output |
fc7ec1d9 | 103 | |
fbcc39ad | 104 | Shortcut to $res->body |
fc7ec1d9 | 105 | |
fbcc39ad | 106 | =item $res->redirect( $url, $status ) |
fc7ec1d9 | 107 | |
108 | Contains a location to redirect to. | |
109 | ||
73a52566 | 110 | $c->response->redirect( 'http://slashdot.org' ); |
111 | $c->response->redirect( 'http://slashdot.org', 307 ); | |
112 | ||
113 | =cut | |
114 | ||
115 | sub redirect { | |
116 | my $self = shift; | |
fbcc39ad | 117 | |
118 | if (@_) { | |
73a52566 | 119 | my $location = shift; |
120 | my $status = shift || 302; | |
121 | ||
122 | $self->location($location); | |
123 | $self->status($status); | |
124 | } | |
125 | ||
126 | return $self->location; | |
127 | } | |
fc7ec1d9 | 128 | |
fbcc39ad | 129 | =item $res->status |
fc7ec1d9 | 130 | |
131 | Contains the HTTP status. | |
132 | ||
133 | $c->response->status(404); | |
fbcc39ad | 134 | |
135 | =item $res->write( $data ) | |
136 | ||
137 | Writes $data to the output stream. | |
138 | ||
139 | =cut | |
140 | ||
141 | sub write { shift->{_context}->write(@_); } | |
fc7ec1d9 | 142 | |
b22c6668 | 143 | =back |
144 | ||
fc7ec1d9 | 145 | =head1 AUTHOR |
146 | ||
147 | Sebastian Riedel, C<sri@cpan.org> | |
61b1e958 | 148 | Marcus Ramberg, C<mramberg@cpan.org> |
fc7ec1d9 | 149 | |
150 | =head1 COPYRIGHT | |
151 | ||
61b1e958 | 152 | This program is free software, you can redistribute it and/or modify |
153 | it under the same terms as Perl itself. | |
fc7ec1d9 | 154 | |
155 | =cut | |
156 | ||
157 | 1; |