*args = \&arguments;
*params = \¶meters;
+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(@_) }
+
+sub _assign_values {
+ my ( $self, $map, $values ) = @_;
+
+ while ( my ( $name, $value ) = splice( @{$values}, 0, 2 ) ) {
+
+ if ( exists $map->{$name} ) {
+ for ( $map->{$name} ) {
+ $_ = [$_] unless ref($_) eq "ARRAY";
+ push( @$_, $value );
+ }
+ }
+ else {
+ $map->{$name} = $value;
+ }
+ }
+}
+
=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->content_encoding;
+ $req->content_length;
+ $req->content_type;
+ $req->cookies;
+ $req->header;
+ $req->headers;
+ $req->hostname;
+ $req->match;
+ $req->method;
+ $req->param;
+ $req->params;
+ $req->parameters;
+ $req->path;
+ $req->referer;
+ $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.
+
-=head2 METHODS
+=head1 METHODS
-=head3 action
+=over 4
-Contains the action.
+=item $req->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
+
+Shortcut for arguments
+
+=item $req->arguments
-Returns an arrayref containing the 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->content_encoding
+
+Shortcut to $req->headers->content_encoding
+
+=item $req->content_length
+
+Shortcut to $req->headers->content_length
-Contains the uri base.
+=item $req->content_type
-=head3 cookies
+Shortcut to $req->headers->content_type
-Returns a hashref containing the cookies.
+=item $req->cookies
+
+Returns a reference to a hash containing the cookies.
print $c->request->cookies->{mycookie}->value;
-=head3 headers
+=item $req->header
+
+Shortcut to $req->headers->header
+
+=item $req->headers
-Returns a L<HTTP::Headers> object containing the 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->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;
-Returns a hashref containing the parameters.
+ if ( @_ == 0 ) {
+ return keys %{ $self->parameters };
+ }
- print $c->request->parameters->{foo};
+ my $param = shift;
-=head3 path
+ unless ( exists $self->parameters->{$param} ) {
+ return wantarray ? () : undef;
+ }
+
+ 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};
+ }
+}
+
+=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
-
-Contains the request method.
+=item $req->referer
- print $c->request->method
+Shortcut to $req->headers->referer. Referring page.
-=head3 snippets
+=item $req->snippets
-Returns an arrayref containing regex 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 };
+ }
+
+ 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};
+ }
+}
+
+=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