local-lib5/man/man3/Catalyst::Response.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Catalyst::Response 3"
 132 .TH Catalyst::Response 3 "2009-11-30" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Catalyst::Response \- stores output responding to the current client request
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 13
 138 \&    $res = $c\->response;
 139 \&    $res\->body;
 140 \&    $res\->code;
 141 \&    $res\->content_encoding;
 142 \&    $res\->content_length;
 143 \&    $res\->content_type;
 144 \&    $res\->cookies;
 145 \&    $res\->header;
 146 \&    $res\->headers;
 147 \&    $res\->output;
 148 \&    $res\->redirect;
 149 \&    $res\->status;
 150 \&    $res\->write;
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 This is the Catalyst Response class, which provides methods for responding to
 155 the current client request. The appropriate Catalyst::Engine for your environment
 156 will turn the Catalyst::Response into a \s-1HTTP\s0 Response and return it to the client.
 157 .SH "METHODS"
 158 .IX Header "METHODS"
 159 .ie n .Sh "$res\->body( $text\fP | \f(CW$fh\fP | \f(CW$iohandle_object )"
 160 .el .Sh "$res\->body( \f(CW$text\fP | \f(CW$fh\fP | \f(CW$iohandle_object\fP )"
 161 .IX Subsection "$res->body( $text | $fh | $iohandle_object )"
 162 .Vb 1
 163 \&    $c\->response\->body('Catalyst rocks!');
 164 .Ve
 165 .PP
 166 Sets or returns the output (text or binary data). If you are returning a large body,
 167 you might want to use a IO::Handle type of object (Something that implements the read method
 168 in the same fashion), or a filehandle \s-1GLOB\s0. Catalyst
 169 will write it piece by piece into the response.
 170 .Sh "$res\->has_body"
 171 .IX Subsection "$res->has_body"
 172 Predicate which returns true when a body has been set.
 173 .Sh "$res\->code"
 174 .IX Subsection "$res->code"
 175 Alias for \f(CW$res\fR\->status.
 176 .Sh "$res\->content_encoding"
 177 .IX Subsection "$res->content_encoding"
 178 Shortcut for \f(CW$res\fR\->headers\->content_encoding.
 179 .Sh "$res\->content_length"
 180 .IX Subsection "$res->content_length"
 181 Shortcut for \f(CW$res\fR\->headers\->content_length.
 182 .Sh "$res\->content_type"
 183 .IX Subsection "$res->content_type"
 184 Shortcut for \f(CW$res\fR\->headers\->content_type.
 185 .PP
 186 This value is typically set by your view or plugin. For example,
 187 Catalyst::Plugin::Static::Simple will guess the mime type based on the file
 188 it found, while Catalyst::View::TT defaults to \f(CW\*(C`text/html\*(C'\fR.
 189 .Sh "$res\->cookies"
 190 .IX Subsection "$res->cookies"
 191 Returns a reference to a hash containing cookies to be set. The keys of the
 192 hash are the cookies' names, and their corresponding values are hash
 193 references used to construct a CGI::Simple::Cookie object.
 194 .PP
 195 .Vb 1
 196 \&    $c\->response\->cookies\->{foo} = { value => '123' };
 197 .Ve
 198 .PP
 199 The keys of the hash reference on the right correspond to the CGI::Simple::Cookie
 200 parameters of the same name, except they are used without a leading dash.
 201 Possible parameters are:
 202 .IP "value" 4
 203 .IX Item "value"
 204 .PD 0
 205 .IP "expires" 4
 206 .IX Item "expires"
 207 .IP "domain" 4
 208 .IX Item "domain"
 209 .IP "path" 4
 210 .IX Item "path"
 211 .IP "secure" 4
 212 .IX Item "secure"
 213 .IP "httponly" 4
 214 .IX Item "httponly"
 215 .PD
 216 .Sh "$res\->header"
 217 .IX Subsection "$res->header"
 218 Shortcut for \f(CW$res\fR\->headers\->header.
 219 .Sh "$res\->headers"
 220 .IX Subsection "$res->headers"
 221 Returns an HTTP::Headers object, which can be used to set headers.
 222 .PP
 223 .Vb 1
 224 \&    $c\->response\->headers\->header( 'X\-Catalyst' => $Catalyst::VERSION );
 225 .Ve
 226 .Sh "$res\->output"
 227 .IX Subsection "$res->output"
 228 Alias for \f(CW$res\fR\->body.
 229 .ie n .Sh "$res\->redirect( $url\fP, \f(CW$status )"
 230 .el .Sh "$res\->redirect( \f(CW$url\fP, \f(CW$status\fP )"
 231 .IX Subsection "$res->redirect( $url, $status )"
 232 Causes the response to redirect to the specified \s-1URL\s0. The default status is
 233 \&\f(CW302\fR.
 234 .PP
 235 .Vb 2
 236 \&    $c\->response\->redirect( 'http://slashdot.org' );
 237 \&    $c\->response\->redirect( 'http://slashdot.org', 307 );
 238 .Ve
 239 .PP
 240 This is a convenience method that sets the Location header to the
 241 redirect destination, and then sets the response status.  You will
 242 want to \f(CW\*(C` return \*(C'\fR or \f(CW\*(C`$c\->detach()\*(C'\fR to interrupt the normal
 243 processing flow if you want the redirect to occur straight away.
 244 .Sh "$res\->location"
 245 .IX Subsection "$res->location"
 246 Sets or returns the \s-1HTTP\s0 'Location'.
 247 .Sh "$res\->status"
 248 .IX Subsection "$res->status"
 249 Sets or returns the \s-1HTTP\s0 status.
 250 .PP
 251 .Vb 1
 252 \&    $c\->response\->status(404);
 253 .Ve
 254 .PP
 255 $res\->code is an alias for this, to match HTTP::Response\->code.
 256 .ie n .Sh "$res\->write( $data )"
 257 .el .Sh "$res\->write( \f(CW$data\fP )"
 258 .IX Subsection "$res->write( $data )"
 259 Writes \f(CW$data\fR to the output stream.
 260 .Sh "meta"
 261 .IX Subsection "meta"
 262 Provided by Moose
 263 .ie n .Sh "$res\->print( @data )"
 264 .el .Sh "$res\->print( \f(CW@data\fP )"
 265 .IX Subsection "$res->print( @data )"
 266 Prints \f(CW@data\fR to the output stream, separated by $,.  This lets you pass
 267 the response object to functions that want to write to an IO::Handle.
 268 .SH "AUTHORS"
 269 .IX Header "AUTHORS"
 270 Catalyst Contributors, see Catalyst.pm
 271 .SH "COPYRIGHT"
 272 .IX Header "COPYRIGHT"
 273 This library is free software. You can redistribute it and/or modify
 274 it under the same terms as Perl itself.