X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=d8b69b279c987fbdb421457e63dbacda6f48987b;hb=47ce945eb2137ee3851d44eff2e5b640157867c8;hp=f06e27e256851e9f06d2c4120a7c40738eb507fb;hpb=0556eb49954590b794221ed3a033565c85dbeb32;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm
index f06e27e..d8b69b2 100644
--- a/lib/Catalyst/Request.pm
+++ b/lib/Catalyst/Request.pm
@@ -4,115 +4,325 @@ use strict;
 use base 'Class::Accessor::Fast';
 
 __PACKAGE__->mk_accessors(
-    qw/action address arguments base cookies headers hostname match method
-      parameters path snippets uploads/
+    qw/action address arguments body base cookies headers hostname match
+      method parameters path protocol secure snippets uploads/
 );
 
 *args   = \&arguments;
+*input  = \&body;
 *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
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+
+    $req = $c->request;
+    $req->action;
+    $req->address;
+    $req->args;
+    $req->arguments;
+    $req->base;
+    $req->body;
+    $req->content_encoding;
+    $req->content_length;
+    $req->content_type;
+    $req->cookies;
+    $req->header;
+    $req->headers;
+    $req->hostname;
+    $req->input;
+    $req->match;
+    $req->method;
+    $req->param;
+    $req->params;
+    $req->parameters;
+    $req->path;
+    $req->protocol;
+    $req->referer;
+    $req->secure;
+    $req->snippets;
+    $req->upload;
+    $req->uploads;
+    $req->user_agent
+
+See also L<Catalyst>.
 
 =head1 DESCRIPTION
 
-The Catalyst Request.
+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.
+
+
+=head1 METHODS
 
-=head2 METHODS
+=over 4
 
-=head3 action
+=item $req->action
 
-Contains the action.
+Contains the requested action.
 
     print $c->request->action;
 
-=head3 address
+=item $req->address
 
 Contains the remote address.
 
     print $c->request->address
 
-=head3 arguments (args)
+=item $req->args
 
-Returns an arrayref containing the arguments.
+Shortcut for arguments
+
+=item $req->arguments
+
+Returns a reference to an array containing the arguments.
 
     print $c->request->arguments->[0];
 
-=head3 base
+=item $req->base
+
+Contains the url base. This will always have a trailing slash.
+
+=item $req->body
+
+Contains the message body of the request unless Content-Type is
+C<application/x-www-form-urlencoded> or C<multipart/form-data>.
+
+    print $c->request->body
+
+=item $req->content_encoding
+
+Shortcut to $req->headers->content_encoding
+
+=item $req->content_length
+
+Shortcut to $req->headers->content_length
+
+=item $req->content_type
 
-Contains the uri base.
+Shortcut to $req->headers->content_type
 
-=head3 cookies
+=item $req->cookies
 
-Returns a hashref containing the cookies.
+Returns a reference to a hash containing the cookies.
 
     print $c->request->cookies->{mycookie}->value;
 
-=head3 headers
+=item $req->header
 
-Returns a L<HTTP::Headers> object containing the headers.
+Shortcut to $req->headers->header
+
+=item $req->headers
+
+Returns an L<HTTP::Headers> object containing the headers.
 
     print $c->request->headers->header('X-Catalyst');
 
-=head3 hostname
+=item $req->hostname
 
-Contains the remote hostname.
+Contains the hostname of the remote user.
 
     print $c->request->hostname
 
-=head3 match
+=item $req->input
+
+Shortcut for $req->body.
+
+=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;
 
-=head3 parameters (params)
+=item $req->method
+
+Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
+
+    print $c->request->method;
+
+=item $req->param
+
+Get request parameters with a CGI.pm like param method.
+
+    $value  = $c->request->param('foo');
+    @values = $c->request->param('foo');
+    @params = $c->request->param;
+
+=cut
+
+sub param {
+    my $self = shift;
+
+    if ( @_ == 0 ) {
+        return keys %{ $self->parameters };
+    }
+
+    if ( @_ == 1 ) {
+
+        my $param = shift;
 
-Returns a hashref containing the parameters.
+        unless ( exists $self->parameters->{$param} ) {
+            return wantarray ? () : undef;
+        }
 
-    print $c->request->parameters->{foo};
+        if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
+            return (wantarray)
+              ? @{ $self->parameters->{$param} }
+              : $self->parameters->{$param}->[0];
+        }
+        else {
+            return (wantarray)
+              ? ( $self->parameters->{$param} )
+              : $self->parameters->{$param};
+        }
+    }
 
-=head3 path
+    if ( @_ => 2  ) {
+
+        while ( my ( $field, $value ) = splice( @_, 0, 2 ) ) {
+
+            if ( exists $self->parameters->{$field} ) {
+                for ( $self->parameters->{$field} ) {
+                    $_ = [$_] unless ref($_) eq "ARRAY";
+                    push( @$_, $value );
+                }
+            }
+            else {
+                $self->parameters->{$field} = $value;
+            }
+        }
+    }
+}
+
+=item $req->params
+
+Shortcut for $req->parameters.
+
+=item $req->parameters
+
+Returns a reference to a hash containing parameters. Values can
+be either a scalar or a arrayref containing scalars.
+
+    print $c->request->parameters->{field};
+    print $c->request->parameters->{field}->[0];
+
+=item $req->path
 
 Contains the path.
 
     print $c->request->path;
 
-=head3 method
+=item $req->protocol
 
-Contains the request method.
+Contains the protocol.
 
-    print $c->request->method
+=item $req->referer
 
-=head3 snippets
+Shortcut to $req->headers->referer. Referring page.
 
-Returns an arrayref containing regex snippets.
+=item $req->secure
+
+Contains a boolean whether the communciation is secure.
+
+=item $req->snippets
+
+Returns a reference to an array containing regex snippets.
 
     my @snippets = @{ $c->request->snippets };
 
-=head3 uploads
+=item $req->upload
+
+A convenient method to $req->uploads.
+
+    $upload  = $c->request->upload('field');
+    @uploads = $c->request->upload('field');
+    @fields  = $c->request->upload;
+
+    for my $upload ( $c->request->upload('field') ) {
+        print $upload->filename;
+    }
+
+=cut
+
+sub upload {
+    my $self = shift;
+
+    if ( @_ == 0 ) {
+        return keys %{ $self->uploads };
+    }
+
+    if ( @_ == 1 ) {
+
+        my $upload = shift;
+
+        unless ( exists $self->uploads->{$upload} ) {
+            return wantarray ? () : undef;
+        }
+
+        if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
+            return (wantarray)
+              ? @{ $self->uploads->{$upload} }
+              : $self->uploads->{$upload}->[0];
+        }
+        else {
+            return (wantarray)
+               ? ( $self->uploads->{$upload} )
+               : $self->uploads->{$upload};
+        }
+    }
+
+    if ( @_ => 2 ) {
+
+        while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
+
+            if ( exists $self->uploads->{$field} ) {
+                for ( $self->uploads->{$field} ) {
+                    $_ = [$_] unless ref($_) eq "ARRAY";
+                    push( @$_, $upload );
+                }
+            }
+            else {
+                $self->uploads->{$field} = $upload;
+            }
+        }
+    }
+}
+
+=item $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.
+
+    my $upload = $c->request->uploads->{field};
+    my $upload = $c->request->uploads->{field}->[0];
+
+=item $req->user_agent
 
-Returns a hashref containing the uploads.
+Shortcut to $req->headers->user_agent. User Agent version string.
 
-    my $filename = $c->req->parameters->{foo};
-    print $c->request->uploads->{$filename}->{type};
-    print $c->request->uploads->{$filename}->{size};
-    my $fh = $c->request->uploads->{$filename}->{fh};
-    my $content = do { local $/; <$fh> };
+=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