Document C::Request and C::Response
Christian Hansen [Mon, 28 Mar 2005 02:38:45 +0000 (02:38 +0000)]
lib/Catalyst/Request.pm
lib/Catalyst/Response.pm

index dd38244..f6ffd4e 100644 (file)
@@ -31,7 +31,11 @@ Catalyst::Request - Catalyst Request Class
     $req->args;
     $req->arguments;
     $req->base;
+    $req->content_encoding;
+    $req->content_length;
+    $req->content_type;
     $req->cookies;
+    $req->header;
     $req->headers;
     $req->hostname;
     $req->match;
@@ -39,8 +43,10 @@ Catalyst::Request - Catalyst Request Class
     $req->parameters;
     $req->params;
     $req->path;
+    $req->referer;
     $req->snippets;
     $req->uploads;
+    $req->user_agent
 
 See also L<Catalyst>.
 
@@ -79,12 +85,28 @@ Returns a reference to an array containing the arguments.
 
 Contains the uri base.
 
+=item $req->content_encoding
+
+Shortcut to $req->headers->content_encoding
+
+=item $req->content_length
+
+Shortcut to $req->headers->content_length
+
+=item $req->content_type
+
+Shortcut to $req->headers->content_type
+
 =item $req->cookies
 
 Returns a reference to a hash containing the cookies.
 
     print $c->request->cookies->{mycookie}->value;
 
+=item $req->header
+
+Shortcut to $req->headers->header
+
 =item $req->headers
 
 Returns an L<HTTP::Headers> object containing the headers.
@@ -103,6 +125,12 @@ Contains the match.
 
     print $c->request->match;
 
+=item $req->method
+
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+
+    print $c->request->method
+
 =item $req->parameters
 
 =item $req->params
@@ -117,11 +145,9 @@ Contains the path.
 
     print $c->request->path;
 
-=item $req->method
-
-Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+=item $req->referer
 
-    print $c->request->method
+Shortcut to $req->headers->referer
 
 =item $req->snippets
 
@@ -139,6 +165,10 @@ Returns a reference to a hash containing the uploads.
     my $fh = $c->request->uploads->{$filename}->{fh};
     my $content = do { local $/; <$fh> };
 
+=item $req->user_agent
+
+Shortcut to $req->headers->user_agent
+
 =back
 
 =head1 AUTHOR
index 1b22e6e..e3278e3 100644 (file)
@@ -17,6 +17,9 @@ Catalyst::Response - Catalyst Response Class
 =head1 SYNOPSIS
 
     $resp = $c->response;
+    $resp->content_encoding;
+    $resp->content_length;
+    $resp->content_type;
     $resp->cookies;
     $resp->headers;
     $resp->output;
@@ -34,12 +37,28 @@ response data.
 
 =over 4
 
+=item $resp->content_encoding
+
+Shortcut to $resp->headers->content_encoding
+
+=item $resp->content_length
+
+Shortcut to $resp->headers->content_length
+
+=item $resp->content_type
+
+Shortcut to $resp->headers->content_type
+
 =item $resp->cookies
 
 Returns a reference to a hash containing the cookies.
 
     $c->response->cookies->{foo} = { value => '123' };
 
+=item $resp->header
+
+Shortcut to $resp->headers->header
+
 =item $resp->headers
 
 Returns a L<HTTP::Headers> object containing the headers.