revised documentation for 5.0
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Request.pm
index 1276fc5..141e6be 100644 (file)
@@ -11,6 +11,13 @@ __PACKAGE__->mk_accessors(
 *args   = \&arguments;
 *params = \&parameters;
 
+sub content_encoding { shift->headers->content_encoding(@_) }
+sub content_length   { shift->headers->content_length(@_)   }
+sub content_type     { shift->headers->content_type(@_)     }
+sub header           { shift->headers->header(@_)           }
+sub referer          { shift->headers->referer(@_)          }
+sub user_agent       { shift->headers->user_agent(@_)       }
+
 =head1 NAME
 
 Catalyst::Request - Catalyst Request Class
@@ -24,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;
@@ -32,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>.
 
@@ -50,7 +63,7 @@ Engine module thus hiding the details of the particular engine implementation.
 
 =item $req->action
 
-Contains the action.
+Contains the requested action.
 
     print $c->request->action;
 
@@ -60,17 +73,31 @@ Contains the remote address.
 
     print $c->request->address
 
-=item $req->arguments
-
 =item $req->args
 
+Shortcut for arguments
+
+=item $req->arguments
+
 Returns a reference to an array containing the arguments.
 
     print $c->request->arguments->[0];
 
 =item $req->base
 
-Contains the uri base.
+Contains the url base. This will always have a trailing slash.
+
+=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
 
@@ -78,6 +105,10 @@ 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.
@@ -86,20 +117,29 @@ Returns an L<HTTP::Headers> object containing the headers.
 
 =item $req->hostname
 
-Contains the remote hostname.
+Contains the hostname of the remote user.
 
     print $c->request->hostname
 
 =item $req->match
 
-Contains the match.
+This contains be the matching part of a regexp action. otherwise it 
+returns the same as 'action'.
 
     print $c->request->match;
 
-=item $req->parameters
+=item $req->method
+
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+
+    print $c->request->method
 
 =item $req->params
 
+Shortcut for $req->parameters.
+
+=item $req->parameters
+
 Returns a reference to a hash containing the parameters.
 
     print $c->request->parameters->{foo};
@@ -110,11 +150,9 @@ Contains the path.
 
     print $c->request->path;
 
-=item $req->method
+=item $req->referer
 
-Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
-
-    print $c->request->method
+Shortcut to $req->headers->referer. Referring page.
 
 =item $req->snippets
 
@@ -132,16 +170,21 @@ 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. User Agent version string.
+
 =back
 
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>
+Marcus Ramberg, C<mramberg@cpan.org>
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+This program is free software, you can redistribute it and/or modify 
+it under the same terms as Perl itself.
 
 =cut