X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=ada6c155f088399da2ef14b49450270d3ecacff7;hp=75ec6d98f41538f6c9c48a3ada049c53a049e767;hb=0ba80bce27a56d366c8d44c254332dd83f9ba0f9;hpb=26e731318112842b5a605bec2092ccae3369c5e4

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index 75ec6d9..ada6c15 100644
--- a/lib/Catalyst/Request.pm
+++ b/lib/Catalyst/Request.pm
@@ -6,7 +6,7 @@ use base 'Class::Accessor::Fast';
 use IO::Socket qw[AF_INET inet_aton];
 
 __PACKAGE__->mk_accessors(
-    qw/action address arguments base cookies handle headers match method
+    qw/action address arguments cookies headers match method
       protocol query_parameters secure snippets uri user/
 );
 
@@ -26,16 +26,15 @@ sub user_agent       { shift->headers->user_agent(@_) }
 
 =head1 NAME
 
-Catalyst::Request - Catalyst Request Class
+Catalyst::Request - provides information about the current client request
 
 =head1 SYNOPSIS
 
-
     $req = $c->request;
     $req->action;
     $req->address;
-    $req->args;
     $req->arguments;
+    $req->args;
     $req->base;
     $req->body;
     $req->body_parameters;
@@ -44,7 +43,6 @@ Catalyst::Request - Catalyst Request Class
     $req->content_type;
     $req->cookie;
     $req->cookies;
-    $req->handle;
     $req->header;
     $req->headers;
     $req->hostname;
@@ -52,8 +50,8 @@ Catalyst::Request - Catalyst Request Class
     $req->match;
     $req->method;
     $req->param;
-    $req->params;
     $req->parameters;
+    $req->params;
     $req->path;
     $req->protocol;
     $req->query_parameters;
@@ -71,47 +69,69 @@ See also L<Catalyst>.
 
 =head1 DESCRIPTION
 
-This is the Catalyst Request class, which provides a set of accessors to the
-request data.  The request object is prepared by the specialized Catalyst
-Engine module thus hiding the details of the particular engine implementation.
-
+This is the Catalyst Request class, which provides an interface to data for the
+current client request. The request object is prepared by L<Catalyst::Engine>,
+thus hiding the details of the particular engine implementation.
 
 =head1 METHODS
 
-=over 4
+=head2 $req->action
+
+Returns the requested action as a L<Catalyst::Action> object.
+
+=head2 $req->address
 
-=item $req->action
+Returns the IP address of the client.
 
-Contains the requested action.
+=head2 $req->arguments
 
-    print $c->request->action;
+Returns a reference to an array containing the arguments.
 
-=item $req->address
+    print $c->request->arguments->[0];
 
-Contains the remote address.
+For example, if your action was
 
-    print $c->request->address
+	package MyApp::C::Foo;
+	
+	sub moose : Local {
+		...
+	}
 
-=item $req->args
+and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
+would be the first and only argument.
 
-Shortcut for arguments
+=head2 $req->args
 
-=item $req->arguments
+Shortcut for arguments.
 
-Returns a reference to an array containing the arguments.
+=head2 $req->base
 
-    print $c->request->arguments->[0];
+Contains the URI base. This will always have a trailing slash.
 
-=item $req->base
+If your application was queried with the URI
+C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
 
-Contains the url base. This will always have a trailing slash.
+=cut
 
-=item $req->body
+sub base {
+    my ( $self, $base ) = @_;
 
-Contains the message body of the request unless Content-Type is
-C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+    return $self->{base} unless $base;
 
-    print $c->request->body
+    $self->{base} = $base;
+
+    # set the value in path for backwards-compat
+    if ( $self->uri ) {
+        $self->path;
+    }
+
+    return $self->{base};
+}
+
+=head2 $req->body
+
+Returns the message body of the request, unless Content-Type is
+C<application/x-www-form-urlencoded> or C<multipart/form-data>.
 
 =cut
 
@@ -121,17 +141,19 @@ sub body {
     return $self->{_body}->body;
 }
 
-=item $req->body_parameters
+=head2 $req->body_parameters
 
-Returns a reference to a hash containing body parameters. Values can
+Returns a reference to a hash containing body (POST) parameters. Values can
 be either a scalar or an arrayref containing scalars.
 
     print $c->request->body_parameters->{field};
     print $c->request->body_parameters->{field}->[0];
+
+These are the parameters from the POST part of the request, if any.
     
-=item $req->body_params
+=head2 $req->body_params
 
-An alias for body_parameters.
+Shortcut for body_parameters.
 
 =cut
 
@@ -142,21 +164,21 @@ sub body_parameters {
     return $self->{body_parameters};
 }
 
-=item $req->content_encoding
+=head2 $req->content_encoding
 
-Shortcut to $req->headers->content_encoding
+Shortcut for $req->headers->content_encoding.
 
-=item $req->content_length
+=head2 $req->content_length
 
-Shortcut to $req->headers->content_length
+Shortcut for $req->headers->content_length.
 
-=item $req->content_type
+=head2 $req->content_type
 
-Shortcut to $req->headers->content_type
+Shortcut for $req->headers->content_type.
 
-=item $req->cookie
+=head2 $req->cookie
 
-A convenient method to $req->cookies.
+A convenient method to access $req->cookies.
 
     $cookie  = $c->request->cookie('name');
     @cookies = $c->request->cookie;
@@ -182,31 +204,28 @@ sub cookie {
     }
 }
 
-=item $req->cookies
+=head2 $req->cookies
 
 Returns a reference to a hash containing the cookies.
 
     print $c->request->cookies->{mycookie}->value;
 
-=item $req->handle
+The cookies in the hash are indexed by name, and the values are L<CGI::Cookie>
+objects.
 
-Request IO handle.
+=head2 $req->header
 
-=item $req->header
+Shortcut for $req->headers->header.
 
-Shortcut to $req->headers->header
+=head2 $req->headers
 
-=item $req->headers
-
-Returns an L<HTTP::Headers> object containing the headers.
+Returns an L<HTTP::Headers> object containing the headers for the current request.
 
     print $c->request->headers->header('X-Catalyst');
 
-=item $req->hostname
-
-Lookup the current users DNS hostname.
+=head2 $req->hostname
 
-    print $c->request->hostname
+Returns the hostname of the client.
     
 =cut
 
@@ -225,32 +244,38 @@ sub hostname {
     return $self->{hostname};
 }
 
-=item $req->input
+=head2 $req->input
 
-Shortcut for $req->body.
+Alias for $req->body.
 
-=item $req->match
+=head2 $req->match
 
-This contains the matching part of a regexp action. Otherwise
+This contains the matching part of a Regex action. Otherwise
 it returns the same as 'action'.
 
-    print $c->request->match;
-
-=item $req->method
+=head2 $req->method
 
 Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
 
-    print $c->request->method;
-
-=item $req->param
+=head2 $req->param
 
-Get request parameters with a CGI.pm-compatible param method. This 
-is a method for accessing parameters in $c->req->parameters.
+Returns GET and POST parameters with a CGI.pm-compatible param method. This 
+is an alternative method for accessing parameters in $c->req->parameters.
 
-    $value  = $c->request->param('foo');
-    @values = $c->request->param('foo');
+    $value  = $c->request->param( 'foo' );
+    @values = $c->request->param( 'foo' );
     @params = $c->request->param;
 
+Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
+arguments to this method, like this:
+
+	$c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
+
+will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
+C<quxx>. Previously this would have added C<bar> as another value to C<foo>
+(creating it if it didn't exist before), and C<quxx> as another value for
+C<gorch>.
+
 =cut
 
 sub param {
@@ -279,93 +304,90 @@ sub param {
               : $self->parameters->{$param};
         }
     }
-
-    if ( @_ > 1 ) {
-
-        while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
-
-            next unless defined $field;
-
-            if ( exists $self->parameters->{$field} ) {
-                for ( $self->parameters->{$field} ) {
-                    $_ = [$_] unless ref($_) eq "ARRAY";
-                    push( @$_, $value );
-                }
-            }
-            else {
-                $self->parameters->{$field} = $value;
-            }
-        }
+    elsif ( @_ > 1 ) {
+        my $field = shift;
+        $self->parameters->{$field} = [@_];
     }
 }
 
-=item $req->params
-
-Shortcut for $req->parameters.
-
-=item $req->parameters
+=head2 $req->parameters
 
-Returns a reference to a hash containing parameters. Values can
+Returns a reference to a hash containing GET and POST parameters. Values can
 be either a scalar or an arrayref containing scalars.
 
     print $c->request->parameters->{field};
     print $c->request->parameters->{field}->[0];
 
+This is the combination of C<query_parameters> and C<body_parameters>.
+
+=head2 $req->params
+
+Shortcut for $req->parameters.
+
 =cut
 
 sub parameters {
     my ( $self, $params ) = @_;
     $self->{_context}->prepare_body;
-    $self->{parameters} = $params if $params;
+    if ( $params ) {
+        if ( ref $params ) {
+            $self->{parameters} = $params;
+        }
+        else {
+            $self->{_context}->log->warn( 
+                "Attempt to retrieve '$params' with req->params(), " .
+                "you probably meant to call req->param('$params')" );
+        }
+    }
     return $self->{parameters};
 }
 
-=item $req->path
+=head2 $req->path
 
-Contains the path.
+Returns the path, i.e. the part of the URI after $req->base, for the current request.
 
-    print $c->request->path;
+=head2 $req->path_info
 
-=item $req->path_info
-
-alias for path, added for compability with L<CGI>
+Alias for path, added for compability with L<CGI>.
 
 =cut
 
 sub path {
     my ( $self, $params ) = @_;
-    
-    if ( $params ) {
-        # base must always have a trailing slash
-        $params .= '/' unless ( $params =~ /\/$/ );
-        $self->uri->path( $params );
+
+    if ($params) {
+        $self->uri->path($params);
+    }
+    else {
+        return $self->{path} if $self->{path};
     }
 
-    my $path = $self->uri->path;
+    my $path     = $self->uri->path;
     my $location = $self->base->path;
     $path =~ s/^(\Q$location\E)?//;
     $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
     $path =~ s/^\///;
-    
+    $self->{path} = $path;
+
     return $path;
 }
 
-=item $req->protocol
+=head2 $req->protocol
 
-Contains the protocol.
+Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
 
-=item $req->query_parameters
+=head2 $req->query_parameters
 
-Returns a reference to a hash containing query parameters. Values can
+Returns a reference to a hash containing query string (GET) parameters. Values can
 be either a scalar or an arrayref containing scalars.
 
     print $c->request->query_parameters->{field};
     print $c->request->query_parameters->{field}->[0];
     
-=item $req->read( [$maxlength] )
+=head2 $req->read( [$maxlength] )
 
-Read a chunk of data from the request body.  This method is designed to be
-used in a while loop, reading $maxlength bytes on every call.  $maxlength
+Reads a chunk of data from the request body. This method is intended to be
+used in a while loop, reading $maxlength bytes on every call. $maxlength
 defaults to the size of the request if not specified.
 
 You have to set MyApp->config->{parse_on_demand} to use this directly.
@@ -374,23 +396,23 @@ You have to set MyApp->config->{parse_on_demand} to use this directly.
 
 sub read { shift->{_context}->read(@_); }
 
-=item $req->referer
+=head2 $req->referer
 
-Shortcut to $req->headers->referer. Referring page.
+Shortcut for $req->headers->referer. Returns the referring page.
 
-=item $req->secure
+=head2 $req->secure
 
-Contains a boolean denoting whether the communication is secure.
+Returns true or false, indicating whether the connection is secure (https).
 
-=item $req->snippets
+=head2 $req->snippets
 
 Returns a reference to an array containing regex snippets.
 
     my @snippets = @{ $c->request->snippets };
 
-=item $req->upload
+=head2 $req->upload
 
-A convenient method to $req->uploads.
+A convenient method to access $req->uploads.
 
     $upload  = $c->request->upload('field');
     @uploads = $c->request->upload('field');
@@ -446,10 +468,10 @@ sub upload {
     }
 }
 
-=item $req->uploads
+=head2 $req->uploads
 
 Returns a reference to a hash containing uploads. Values can be either a
-hashref or a arrayref containing C<Catalyst::Request::Upload> objects.
+hashref or a arrayref containing L<Catalyst::Request::Upload> objects.
 
     my $upload = $c->request->uploads->{field};
     my $upload = $c->request->uploads->{field}->[0];
@@ -463,23 +485,24 @@ sub uploads {
     return $self->{uploads};
 }
 
-=item $req->uri
-
-Returns a URI object for the request.
+=head2 $req->uri
 
-=item $req->user
+Returns a URI object for the current request. Stringifies to the URI text.
 
-Contains the user name of user if authentication check was successful.
+=head2 $req->user
 
-=item $req->user_agent
+Returns the currently logged in user. Deprecated. The method recommended for
+newer plugins is $c->user.
 
-Shortcut to $req->headers->user_agent. User Agent version string.
+=head2 $req->user_agent
 
-=back
+Shortcut to $req->headers->user_agent. Returns the user agent (browser)
+version string.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Marcus Ramberg, C<mramberg@cpan.org>
 
 =head1 COPYRIGHT