lib/Catalyst/Response.pm

   1 package Catalyst::Response;
   2
   3 use strict;
   4 use base 'Class::Accessor::Fast';
   5
   6 __PACKAGE__->mk_accessors(qw/cookies body headers location status/);
   7
   8 *output = \&body;
   9
  10 sub content_encoding { shift->headers->content_encoding(@_) }
  11 sub content_length   { shift->headers->content_length(@_) }
  12 sub content_type     { shift->headers->content_type(@_) }
  13 sub header           { shift->headers->header(@_) }
  14
  15 =head1 NAME
  16
  17 Catalyst::Response - Catalyst Response Class
  18
  19 =head1 SYNOPSIS
  20
  21     $res = $c->response;
  22     $res->body;
  23     $res->content_encoding;
  24     $res->content_length;
  25     $res->content_type;
  26     $res->cookies;
  27     $res->header;
  28     $res->headers;
  29     $res->output;
  30     $res->redirect;
  31     $res->status;
  32     $res->write;
  33
  34 See also L<Catalyst::Application>.
  35
  36 =head1 DESCRIPTION
  37
  38 This is the Catalyst Response class, which provides a set of accessors
  39 to response data.
  40
  41 =head1 METHODS
  42
  43 =over 4
  44
  45 =item $res->body($text)
  46
  47     $c->response->body('Catalyst rocks!');
  48
  49 Contains the final output.
  50
  51 =item $res->content_encoding
  52
  53 Shortcut to $res->headers->content_encoding
  54
  55 =item $res->content_length
  56
  57 Shortcut to $res->headers->content_length
  58
  59 =item $res->content_type
  60
  61 Shortcut to $res->headers->content_type
  62
  63 =item $res->cookies
  64
  65 Returns a reference to a hash containing the cookies to be set.
  66
  67     $c->response->cookies->{foo} = { value => '123' };
  68
  69 =item $res->header
  70
  71 Shortcut to $res->headers->header
  72
  73 =item $res->headers
  74
  75 Returns a L<HTTP::Headers> object containing the headers.
  76
  77     $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
  78
  79 =item $res->output
  80
  81 Shortcut to $res->body
  82
  83 =item $res->redirect( $url, $status )
  84
  85 Contains a location to redirect to.
  86
  87     $c->response->redirect( 'http://slashdot.org' );
  88     $c->response->redirect( 'http://slashdot.org', 307 );
  89
  90 =cut
  91
  92 sub redirect {
  93     my $self = shift;
  94
  95     if (@_) {
  96         my $location = shift;
  97         my $status   = shift || 302;
  98
  99         $self->location($location);
 100         $self->status($status);
 101     }
 102
 103     return $self->location;
 104 }
 105
 106 =item $res->status
 107
 108 Contains the HTTP status.
 109
 110     $c->response->status(404);
 111
 112 =item $res->write( $data )
 113
 114 Writes $data to the output stream.
 115
 116 =cut
 117
 118 sub write { shift->{_context}->write(@_); }
 119
 120 =back
 121
 122 =head1 AUTHOR
 123
 124 Sebastian Riedel, C<sri@cpan.org>
 125 Marcus Ramberg, C<mramberg@cpan.org>
 126
 127 =head1 COPYRIGHT
 128
 129 This program is free software, you can redistribute it and/or modify
 130 it under the same terms as Perl itself.
 131
 132 =cut
 133
 134 1;