X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=8f965052d62adc7c7914ee06d2e5977307d1c6d1;hb=032221564b1da678e7f13b97a4cd99a05a31c35c;hp=f6ffd4ef5e5688804607d8d2a56e0e68f0ee46a1;hpb=b5176d9ee9b99c2550fc202ee25709d431482ede;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index f6ffd4e..8f96505 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -4,11 +4,12 @@ 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 = \¶meters; sub content_encoding { shift->headers->content_encoding(@_) } @@ -31,6 +32,7 @@ Catalyst::Request - Catalyst Request Class $req->args; $req->arguments; $req->base; + $req->body; $req->content_encoding; $req->content_length; $req->content_type; @@ -38,13 +40,18 @@ Catalyst::Request - Catalyst Request Class $req->header; $req->headers; $req->hostname; + $req->input; $req->match; $req->method; - $req->parameters; + $req->param; $req->params; + $req->parameters; $req->path; + $req->protocol; $req->referer; + $req->secure; $req->snippets; + $req->upload; $req->uploads; $req->user_agent @@ -63,7 +70,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; @@ -73,17 +80,26 @@ 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->body + +Contains the message body of the request unless Content-Type is +C or C. + + print $c->request->body =item $req->content_encoding @@ -115,13 +131,18 @@ 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->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; @@ -129,15 +150,73 @@ Contains the match. Contains the request method (C, C, C, etc). - print $c->request->method + print $c->request->method; -=item $req->parameters +=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; + + 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}; + } + } + + if ( @_ > 1 ) { + + 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 -Returns a reference to a hash containing the parameters. +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->{foo}; + print $c->request->parameters->{field}; + print $c->request->parameters->{field}->[0]; =item $req->path @@ -145,9 +224,17 @@ Contains the path. print $c->request->path; +=item $req->protocol + +Contains the protocol. + =item $req->referer -Shortcut to $req->headers->referer +Shortcut to $req->headers->referer. Referring page. + +=item $req->secure + +Contains a boolean whether the communciation is secure. =item $req->snippets @@ -155,30 +242,87 @@ 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 }; + } + + 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 ( @_ > 1 ) { + + 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 the uploads. +Returns a reference to a hash containing uploads. Values can be either a +hashref or a arrayref containing C objects. - 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> }; + my $upload = $c->request->uploads->{field}; + my $upload = $c->request->uploads->{field}->[0]; =item $req->user_agent -Shortcut to $req->headers->user_agent +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