http::request::params(3pm) [debian man page]

HTTP::Request::Params(3pm)				User Contributed Perl Documentation				HTTP::Request::Params(3pm)

NAME

       HTTP::Request::Params - Retrieve GET/POST Parameters from HTTP Requests

SYNOPSIS

	 use HTTP::Request::Params;

	 my $http_request = read_request();
	 my $parse_params = HTTP::Request::Params->new({
			      req => $http_request,
			    });
	 my $params	  = $parse_params->params;

DESCRIPTION

       This software does all the dirty work of parsing HTTP Requests to find incoming query parameters.

   new
	 my $parser = HTTP::Request::Params->new({
			 req => $http_request,
		      });

       "req" - This required argument is either an "HTTP::Request" object or a string containing an entier HTTP Request.

       Incoming query parameters come from two places. The first place is the "query" portion of the URL. Second is the content portion of an HTTP
       request as is the case when parsing a POST request, for example.

   params
	 my $params = $parser->params;

       Returns a hash reference containing all the parameters. The keys in this hash are the names of the parameters. Values are the values
       associated with those parameters in the incoming query. For parameters with multiple values, the value in this hash will be a list
       reference. This is the same behaviour as the "CGI" module's "Vars()" function.

   req
	 my $req_object = $parser->req;

       Returns the "HTTP::Request" object.

   mime
	 my $mime_object = $parser->mime;

       Returns the "Email::MIME" object.

       Now, you may be wondering why we're dealing with an "Email::MIME" object.  The answer is simple. It's an amazing parser for MIME compliant
       messages, and RFC 822 compliant messages. When parsing incoming POST data, especially file uploads, "Email::MIME" is the perfect fit. It's
       fast and light.

SEE ALSO

       "HTTP::Daemon", HTTP::Request, Email::MIME, CGI, perl.

AUTHOR

       Casey West, <casey@geeknest.com>.

COPYRIGHT

	 Copyright (c) 2005 Casey West.  All rights reserved.
	 This module is free software; you can redistribute it and/or modify it
	 under the same terms as Perl itself.

perl v5.10.1							    2005-01-12						HTTP::Request::Params(3pm)

Mojo::Message::Request(3pm)				User Contributed Perl Documentation			       Mojo::Message::Request(3pm)

NAME

       Mojo::Message::Request - HTTP 1.1 request container

SYNOPSIS

	 use Mojo::Message::Request;

	 # Parse
	 my $req = Mojo::Message::Request->new;
	 $req->parse("GET /foo HTTP/1.0x0ax0d");
	 $req->parse("Content-Length: 12x0ax0dx0ax0d");
	 $req->parse("Content-Type: text/plainx0ax0dx0ax0d");
	 $req->parse('Hello World!');
	 say $req->body;

	 # Build
	 my $req = Mojo::Message::Request->new;
	 $req->url->parse('http://127.0.0.1/foo/bar');
	 $req->method('GET');
	 say $req->to_string;

DESCRIPTION

       Mojo::Message::Request is a container for HTTP 1.1 requests as described in RFC 2616.

EVENTS

       Mojo::Message::Request inherits all events from Mojo::Message.

ATTRIBUTES

       Mojo::Message::Request inherits all attributes from Mojo::Message and implements the following new ones.

   "env"
	 my $env = $req->env;
	 $req	 = $req->env({});

       Direct access to the "CGI" or "PSGI" environment hash if available.

	 # Check CGI version
	 my $version = $req->env->{GATEWAY_INTERFACE};

	 # Check PSGI version
	 my $version = $req->env->{'psgi.version'};

   "method"
	 my $method = $req->method;
	 $req	    = $req->method('POST');

       HTTP request method, defaults to "GET".

   "url"
	 my $url = $req->url;
	 $req	 = $req->url(Mojo::URL->new);

       HTTP request URL, defaults to a Mojo::URL object.

	 my $foo = $req->url->query->to_hash->{foo};

METHODS

       Mojo::Message::Request inherits all methods from Mojo::Message and implements the following new ones.

   "clone"
	 my $clone = $req->clone;

       Clone request if possible, otherwise return "undef".

   "cookies"
	 my $cookies = $req->cookies;
	 $req	     = $req->cookies(Mojo::Cookie::Request->new);
	 $req	     = $req->cookies({name => 'foo', value => 'bar'});

       Access request cookies, usually Mojo::Cookie::Request objects.

	 say $req->cookies->[1]->value;

   "fix_headers"
	 $req = $req->fix_headers;

       Make sure request has all required headers for the current HTTP version.

   "is_secure"
	 my $success = $req->is_secure;

       Check if connection is secure.

   "is_xhr"
	 my $success = $req->is_xhr;

       Check "X-Requested-With" header for "XMLHttpRequest" value.

   "param"
	 my @names = $req->param;
	 my $foo   = $req->param('foo');
	 my @foo   = $req->param('foo');

       Access "GET" and "POST" parameters. Note that this method caches all data, so it should not be called before the entire request body has
       been received.

   "params"
	 my $p = $req->params;

       All "GET" and "POST" parameters, usually a Mojo::Parameters object.

	 say $req->params->param('foo');

   "parse"
	 $req = $req->parse('GET /foo/bar HTTP/1.1');
	 $req = $req->parse(REQUEST_METHOD => 'GET');
	 $req = $req->parse({REQUEST_METHOD => 'GET'});

       Parse HTTP request chunks or environment hash.

   "proxy"
	 my $proxy = $req->proxy;
	 $req	   = $req->proxy('http://foo:bar@127.0.0.1:3000');
	 $req	   = $req->proxy(Mojo::URL->new('http://127.0.0.1:3000'));

       Proxy URL for request.

	 # Disable proxy
	 $req->proxy(0);

   "query_params"
	 my $p = $req->query_params;

       All "GET" parameters, usually a Mojo::Parameters object.

	 say $req->query_params->to_hash->{'foo'};

SEE ALSO

       Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.

perl v5.14.2							    2012-09-05					       Mojo::Message::Request(3pm)