Catalyst::Request - provides information about the current client request

    $req = $c->request;
    $req->action;
    $req->address;
    $req->arguments;
    $req->args;
    $req->base;
    $req->body;
    $req->body_parameters;
    $req->content_encoding;
    $req->content_length;
    $req->content_type;
    $req->cookie;
    $req->cookies;
    $req->header;
    $req->headers;
    $req->hostname;
    $req->input;
    $req->match;
    $req->method;
    $req->param;
    $req->parameters;
    $req->params;
    $req->path;
    $req->protocol;
    $req->query_parameters;
    $req->read;
    $req->referer;
    $req->secure;
    $req->snippets;
    $req->upload;
    $req->uploads;
    $req->uri;
    $req->user;
    $req->user_agent;

See also Catalyst.

This is the Catalyst Request class, which provides an interface to data for the current client request. The request object is prepared by Catalyst::Engine, thus hiding the details of the particular engine implementation.

Returns the requested action as a Catalyst::Action object.

Returns the IP address of the client.

Returns a reference to an array containing the arguments.

    print $c->request->arguments->[0];

For example, if your action was

        package MyApp::C::Foo;

        sub moose : Local {
                ...
        }

and the URI for the request was CWhttp://.../foo/moose/bah, the string CWbah would be the first and only argument.

Shortcut for arguments.

Contains the URI base. This will always have a trailing slash.

If your application was queried with the URI CWhttp://localhost:3000/some/path then CWbase is CWhttp://localhost:3000/.

Returns the message body of the request, unless Content-Type is CWapplication/x-www-form-urlencoded or CWmultipart/form-data.

Returns a reference to a hash containing body (POST) parameters. Values can be either a scalar or an arrayref containing scalars.

    print $c->request->body_parameters->{field};
    print $c->request->body_parameters->{field}->[0];

These are the parameters from the POST part of the request, if any.

Shortcut for body_parameters.

Shortcut for CW$req->headers->content_encoding.

Shortcut for CW$req->headers->content_length.

Shortcut for CW$req->headers->content_type.

A convenient method to access CW$req->cookies.

    $cookie  = $c->request->cookie('name');
    @cookies = $c->request->cookie;

Returns a reference to a hash containing the cookies.

    print $c->request->cookies->{mycookie}->value;

The cookies in the hash are indexed by name, and the values are CGI::Cookie objects.

Shortcut for CW$req->headers->header.

Returns an HTTP::Headers object containing the headers for the current request.

    print $c->request->headers->header('X-Catalyst');

Returns the hostname of the client.

Alias for CW$req->body.

This contains the matching part of a Regex action. Otherwise it returns the same as 'action'.

Contains the request method (CWGET, CWPOST, CWHEAD, etc).

Returns GET and POST parameters with a CGI.pm-compatible param method. This is an alternative method for accessing parameters in CW$c->req->parameters.

    $value  = $c->request->param( 'foo' );
    @values = $c->request->param( 'foo' );
    @params = $c->request->param;

Like CGI, and unlike earlier versions of Catalyst, passing multiple arguments to this method, like this:

        $c->request->param( 'foo', 'bar', 'gorch', 'quxx' );

will set the parameter CWfoo to the multiple values CWbar, CWgorch and CWquxx. Previously this would have added CWbar as another value to CWfoo (creating it if it didn't exist before), and CWquxx as another value for CWgorch.

Returns a reference to a hash containing GET and POST parameters. Values can be either a scalar or an arrayref containing scalars.

    print $c->request->parameters->{field};
    print $c->request->parameters->{field}->[0];

This is the combination of CWquery_parameters and CWbody_parameters.

Shortcut for CW$req->parameters.

Returns the path, i.e. the part of the URI after CW$req->base, for the current request.

Alias for path, added for compability with CGI.

Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.

Returns a reference to a hash containing query string (GET) parameters. Values can be either a scalar or an arrayref containing scalars.

    print $c->request->query_parameters->{field};
    print $c->request->query_parameters->{field}->[0];

Reads a chunk of data from the request body. This method is intended to be used in a while loop, reading CW$maxlength bytes on every call. CW$maxlength defaults to the size of the request if not specified.

You have to set MyApp->config->{parse_on_demand} to use this directly.

Shortcut for CW$req->headers->referer. Returns the referring page.

Returns true or false, indicating whether the connection is secure (https).

Returns a reference to an array containing regex snippets.

    my @snippets = @{ $c->request->snippets };

A convenient method to access CW$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;
    }

Returns a reference to a hash containing uploads. Values can be either a hashref or a arrayref containing Catalyst::Request::Upload objects.

    my $upload = $c->request->uploads->{field};
    my $upload = $c->request->uploads->{field}->[0];

Returns a URI object for the current request. Stringifies to the URI text.

Returns the currently logged in user. Deprecated. The method recommended for newer plugins is CW$c->user.

Shortcut to CW$req->headers->user_agent. Returns the user agent (browser) version string.

Sebastian Riedel, CWsri@cpan.org

Marcus Ramberg, CWmramberg@cpan.org

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.