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=22516e1f084f680d1ebe46681c3134ef7b8e8ef3;hp=1276fc5357f65a2a5effe94b7b1d31dcdb92d2e7;hb=f5771415ac7632c99baaa5810fd65cf30988ba5d;hpb=b22c66686d892bba76a150f727561f8778f3ea72 diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index 1276fc5..22516e1 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -11,6 +11,30 @@ __PACKAGE__->mk_accessors( *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 @@ -24,16 +48,24 @@ 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; $req->method; - $req->parameters; + $req->param; $req->params; + $req->parameters; $req->path; + $req->referer; $req->snippets; + $req->upload; $req->uploads; + $req->user_agent See also L. @@ -50,7 +82,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 +92,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 +124,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 object containing the headers. @@ -86,23 +136,69 @@ Returns an L 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, C, C, 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 }; + } + + my $param = shift; + + 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 -Returns a reference to a hash containing the parameters. +Shortcut for $req->parameters. - print $c->request->parameters->{foo}; +=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 @@ -110,11 +206,9 @@ Contains the path. print $c->request->path; -=item $req->method - -Contains the request method (C, C, C, etc). +=item $req->referer - print $c->request->method +Shortcut to $req->headers->referer. Referring page. =item $req->snippets @@ -122,26 +216,68 @@ Returns a reference to an array containing regex snippets. my @snippets = @{ $c->request->snippets }; +=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 the uploads. +Returns a reference to a hash containing uploads. Values can be either a +hashref or a arrayref containing C objects. + + my $upload = $c->request->uploads->{field}; + my $upload = $c->request->uploads->{field}->[0]; + +=item $req->user_agent - 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> }; +Shortcut to $req->headers->user_agent. User Agent version string. =back =head1 AUTHOR Sebastian Riedel, C +Marcus Ramberg, C =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