Marcus Ramberg > Catalyst-Runtime-5.7003 > Catalyst::Response

Download:
Catalyst-Runtime-5.7003.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  23
Open  15
Stalled  1
View/Report Bugs
Source   Latest Release: Catalyst-Runtime-5.90079_003

NAME ^

Catalyst::Response - stores output responding to the current client request

SYNOPSIS ^

    $res = $c->response;
    $res->body;
    $res->content_encoding;
    $res->content_length;
    $res->content_type;
    $res->cookies;
    $res->header;
    $res->headers;
    $res->output;
    $res->redirect;
    $res->status;
    $res->write;

DESCRIPTION ^

This is the Catalyst Response class, which provides methods for responding to the current client request.

METHODS ^

$res->body($text)

    $c->response->body('Catalyst rocks!');

Sets or returns the output (text or binary data).

$res->content_encoding

Shortcut for $res->headers->content_encoding.

$res->content_length

Shortcut for $res->headers->content_length.

$res->content_type

Shortcut for $res->headers->content_type.

This value is typically set by your view or plugin. For example, Catalyst::Plugin::Static::Simple will guess the mime type based on the file it found, while Catalyst::View::TT defaults to text/html.

$res->cookies

Returns a reference to a hash containing cookies to be set. The keys of the hash are the cookies' names, and their corresponding values are hash references used to construct a CGI::Cookie object.

    $c->response->cookies->{foo} = { value => '123' };

The keys of the hash reference on the right correspond to the CGI::Cookie parameters of the same name, except they are used without a leading dash. Possible parameters are:

value
expires
domain
path
secure

$res->header

Shortcut for $res->headers->header.

$res->headers

Returns an HTTP::Headers object, which can be used to set headers.

    $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );

$res->output

Alias for $res->body.

$res->redirect( $url, $status )

Causes the response to redirect to the specified URL.

    $c->response->redirect( 'http://slashdot.org' );
    $c->response->redirect( 'http://slashdot.org', 307 );

$res->status

Sets or returns the HTTP status.

    $c->response->status(404);

$res->write( $data )

Writes $data to the output stream.

AUTHORS ^

Sebastian Riedel, sri@cpan.org

Marcus Ramberg, mramberg@cpan.org

COPYRIGHT ^

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: