X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest.pm;h=1276fc5357f65a2a5effe94b7b1d31dcdb92d2e7;hb=585893b98efe1cf95118f2686108959fdebb0fab;hp=f06e27e256851e9f06d2c4120a7c40738eb507fb;hpb=0556eb49954590b794221ed3a033565c85dbeb32;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index f06e27e..1276fc5 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -17,87 +17,114 @@ Catalyst::Request - Catalyst Request Class =head1 SYNOPSIS -See L. + + $req = $c->request; + $req->action; + $req->address; + $req->args; + $req->arguments; + $req->base; + $req->cookies; + $req->headers; + $req->hostname; + $req->match; + $req->method; + $req->parameters; + $req->params; + $req->path; + $req->snippets; + $req->uploads; + +See also L. =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. print $c->request->action; -=head3 address +=item $req->address Contains the remote address. print $c->request->address -=head3 arguments (args) +=item $req->arguments -Returns an arrayref containing the arguments. +=item $req->args + +Returns a reference to an array containing the arguments. print $c->request->arguments->[0]; -=head3 base +=item $req->base Contains the uri base. -=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->headers -Returns a L object containing the headers. +Returns an L object containing the headers. print $c->request->headers->header('X-Catalyst'); -=head3 hostname +=item $req->hostname Contains the remote hostname. print $c->request->hostname -=head3 match +=item $req->match Contains the match. print $c->request->match; -=head3 parameters (params) +=item $req->parameters + +=item $req->params -Returns a hashref containing the parameters. +Returns a reference to a hash containing the parameters. print $c->request->parameters->{foo}; -=head3 path +=item $req->path Contains the path. print $c->request->path; -=head3 method +=item $req->method -Contains the request method. +Contains the request method (C, C, C, etc). print $c->request->method -=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->uploads -Returns a hashref containing the uploads. +Returns a reference to a hash containing the uploads. my $filename = $c->req->parameters->{foo}; print $c->request->uploads->{$filename}->{type}; @@ -105,6 +132,8 @@ Returns a hashref containing the uploads. my $fh = $c->request->uploads->{$filename}->{fh}; my $content = do { local $/; <$fh> }; +=back + =head1 AUTHOR Sebastian Riedel, C