.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTTP::Request::Params 3pm"
.TH HTTP::Request::Params 3pm "2022-06-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTTP::Request::Params \- Retrieve GET/POST Parameters from HTTP Requests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use HTTP::Request::Params;
\&  
\&  my $http_request = read_request();
\&  my $parse_params = HTTP::Request::Params\->new({
\&                       req => $http_request,
\&                     });
\&  my $params       = $parse_params\->params;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This software does all the dirty work of parsing \s-1HTTP\s0 Requests to find
incoming query parameters.
.SS "new"
.IX Subsection "new"
.Vb 3
\&  my $parser = HTTP::Request::Params\->new({
\&                  req => $http_request,
\&               });
.Ve
.PP
\&\f(CW\*(C`req\*(C'\fR \- This required argument is either an \f(CW\*(C`HTTP::Request\*(C'\fR object or a
string containing an entier \s-1HTTP\s0 Request.
.PP
Incoming query parameters come from two places. The first place is the
\&\f(CW\*(C`query\*(C'\fR portion of the \s-1URL.\s0 Second is the content portion of an \s-1HTTP\s0
request as is the case when parsing a \s-1POST\s0 request, for example.
.SS "params"
.IX Subsection "params"
.Vb 1
\&  my $params = $parser\->params;
.Ve
.PP
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 \f(CW\*(C`CGI\*(C'\fR
module's \f(CW\*(C`Vars()\*(C'\fR function.
.SS "req"
.IX Subsection "req"
.Vb 1
\&  my $req_object = $parser\->req;
.Ve
.PP
Returns the \f(CW\*(C`HTTP::Request\*(C'\fR object.
.SS "mime"
.IX Subsection "mime"
.Vb 1
\&  my $mime_object = $parser\->mime;
.Ve
.PP
Returns the \f(CW\*(C`Email::MIME\*(C'\fR object.
.PP
Now, you may be wondering why we're dealing with an \f(CW\*(C`Email::MIME\*(C'\fR object.
The answer is simple. It's an amazing parser for \s-1MIME\s0 compliant messages,
and \s-1RFC 822\s0 compliant messages. When parsing incoming \s-1POST\s0 data, especially
file uploads, \f(CW\*(C`Email::MIME\*(C'\fR is the perfect fit. It's fast and light.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`HTTP::Daemon\*(C'\fR,
HTTP::Request,
Email::MIME,
\&\s-1CGI\s0,
perl.
.SH "AUTHOR"
.IX Header "AUTHOR"
Casey West, <\fIcasey@geeknest.com\fR>.
Ian Stuart, <\fIIan.Stuart@ed.ac.uk\fR>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 3
\&  Copyright (c) 2015 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.
.Ve